Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter.regex
Class RegexTokenFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.filter.regex.RegexFilter
      extended by com.jivesoftware.forum.renderer.filter.regex.RegexTokenFilter
Direct Known Subclasses:
MacroFilter, SqlCodeFormatter, WikiLinkRenderer, WikiListRenderer, XmlCodeFormatter

public abstract class RegexTokenFilter
extends RegexFilter


Field Summary
 
Fields inherited from class com.jivesoftware.forum.renderer.filter.regex.RegexFilter
MULTILINE, pattern, SINGLELINE, substitute
 
Constructor Summary
RegexTokenFilter()
           
RegexTokenFilter(java.lang.String regex)
          Create a new multiline regular expression.
RegexTokenFilter(java.lang.String regex, boolean multiline)
          Create a new regular expression.
 
Method Summary
 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 occurnce of a regular expression.
protected abstract  void setUp(RenderContext renderContext)
          Setup.
 
Methods inherited from class com.jivesoftware.forum.renderer.filter.regex.RegexFilter
addRegex, addRegex, addRegex, addRegex, clearRegex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegexTokenFilter

public RegexTokenFilter()

RegexTokenFilter

public RegexTokenFilter(java.lang.String regex,
                        boolean multiline)
Create a new regular expression.

Parameters:
multiline - true if multiline, false otherwise.

RegexTokenFilter

public RegexTokenFilter(java.lang.String regex)
Create a new multiline regular expression.

Method Detail

setUp

protected abstract void setUp(RenderContext renderContext)
Setup.

Parameters:
renderContext - the rendercontext

handleMatch

public abstract void handleMatch(java.lang.StringBuffer buffer,
                                 JdkMatchResult result,
                                 RenderContext renderContext)
Method is called for every occurnce 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 - FilterContext for filters

filter

public java.lang.String filter(java.lang.String input,
                               RenderContext renderContext)
Specified by:
filter in class RegexFilter

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.