Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class AbstractRegexTokenRenderFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.AbstractRenderFilter
      extended by com.jivesoftware.forum.renderer.filter.AbstractRegexTokenRenderFilter
All Implemented Interfaces:
RenderFilter
Direct Known Subclasses:
AbstractClassicRegexTokenRenderFilter, ForceNewlineFilter

public abstract class AbstractRegexTokenRenderFilter
extends AbstractRenderFilter


Field Summary
static boolean MULTILINE
           
static boolean SINGLELINE
           
 
Constructor Summary
AbstractRegexTokenRenderFilter()
           
 
Method Summary
 void addRegex(JdkPattern pattern, java.lang.String substitute)
           
 void addRegex(java.lang.String regex, java.lang.String substitute)
           
 void addRegex(java.lang.String regex, java.lang.String substitute, boolean multiline)
           
 void clearRegex()
           
 java.lang.String filter(java.lang.String input, RenderContext renderContext)
           
abstract  void handleMatch(java.lang.StringBuffer buffer, JdkMatchResult result, RenderContext renderContext)
          Method is called for every occurance of a regular expression.
 
Methods inherited from class com.jivesoftware.forum.renderer.AbstractRenderFilter
execute, executeHtmlTarget, executeNoMarkupTarget, executePlainEmailTarget, executePlainTextTarget, executeWysiwygEditorTarget, getDefaultHelp, getDocumentationMap, getName, getUserDocumentation, isEnabled, isEnabledByDefault, setEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SINGLELINE

public static final boolean SINGLELINE
See Also:
Constant Field Values

MULTILINE

public static final boolean MULTILINE
See Also:
Constant Field Values
Constructor Detail

AbstractRegexTokenRenderFilter

public AbstractRegexTokenRenderFilter()
Method Detail

clearRegex

public void clearRegex()

addRegex

public void addRegex(java.lang.String regex,
                     java.lang.String substitute)

addRegex

public void addRegex(java.lang.String regex,
                     java.lang.String substitute,
                     boolean multiline)

addRegex

public void addRegex(JdkPattern pattern,
                     java.lang.String substitute)

handleMatch

public abstract void handleMatch(java.lang.StringBuffer buffer,
                                 JdkMatchResult result,
                                 RenderContext renderContext)
Method is called for every occurance of a regular expression. Subclasses have to implement this method.

Parameters:
buffer - Buffer to write replacement string to
result - Hit with the found regular expression
renderContext - RenderContext for filters
See Also:
RegexTokenFilter.handleMatch(StringBuffer, com.jivesoftware.forum.renderer.filter.regex.jdk.JdkMatchResult, com.jivesoftware.forum.renderer.RenderContext)

filter

public java.lang.String filter(java.lang.String input,
                               RenderContext renderContext)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.