Package org.apache.wiki.filters

Class ProfanityFilter

java.lang.Object
org.apache.wiki.api.filters.BasePageFilter
org.apache.wiki.filters.ProfanityFilter
All Implemented Interfaces:
PageFilter
public class ProfanityFilter
extends BasePageFilter
This class is an example of how to have a simple filter. It removes all nasty words located at profanity.properties file, inside org/apache/wiki/filters package. The search of profanities is case unsensitive.

  • Field Summary

    Fields inherited from class org.apache.wiki.api.filters.BasePageFilter

    m_engine

  • Constructor Summary

    Constructors
    Constructor Description
    ProfanityFilter()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String preTranslate​(Context context, java.lang.String content)
    This method is called whenever a page has been loaded from the provider, but not yet been sent through the markup-translation process.

    Methods inherited from class org.apache.wiki.api.filters.BasePageFilter

    initialize

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.apache.wiki.api.filters.PageFilter

    destroy, postSave, postTranslate, preSave

  • Constructor Details

  • Method Details

    • preTranslate

      public java.lang.String preTranslate​(Context context, java.lang.String content)
      This method is called whenever a page has been loaded from the provider, but not yet been sent through the markup-translation process. Note that you cannot do HTML translation here, because it will be escaped.
      Parameters:
      context - The current context.
      content - WikiMarkup.
      Returns:
      The modified wikimarkup content. Default implementation returns the markup as received.