Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class MacroFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.filter.regex.RegexFilter
      extended by com.jivesoftware.forum.renderer.filter.regex.RegexTokenFilter
          extended by com.jivesoftware.forum.renderer.filter.MacroFilter

public class MacroFilter
extends RegexTokenFilter

Class that finds (macros) like {link:java|http://www.java.com} --->

Field Summary
static java.lang.String SINGLE_TAG_REGEX
           
 
Fields inherited from class com.jivesoftware.forum.renderer.filter.regex.RegexFilter
MULTILINE, pattern, SINGLELINE, substitute
 
Constructor Summary
MacroFilter(java.util.List macros)
           
MacroFilter(java.util.List macros, boolean escapeAll)
           
 
Method Summary
 java.lang.String filterMacros(java.lang.String input, RenderContext renderContext)
           
protected  java.lang.String filterMacros(java.lang.String input, RenderContext renderContext, boolean isMatchedTags)
           
 void handleMatch(java.lang.StringBuffer buffer, JdkMatchResult result, RenderContext renderContext)
          Method is called for every occurnce of a regular expression.
protected  void setUp(RenderContext renderContext)
          Setup.
 
Methods inherited from class com.jivesoftware.forum.renderer.filter.regex.RegexTokenFilter
filter
 
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
 

Field Detail

SINGLE_TAG_REGEX

public static final java.lang.String SINGLE_TAG_REGEX
See Also:
Constant Field Values
Constructor Detail

MacroFilter

public MacroFilter(java.util.List macros)

MacroFilter

public MacroFilter(java.util.List macros,
                   boolean escapeAll)
Method Detail

setUp

protected void setUp(RenderContext renderContext)
Description copied from class: RegexTokenFilter
Setup.

Specified by:
setUp in class RegexTokenFilter
Parameters:
renderContext - the rendercontext

filterMacros

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

filterMacros

protected java.lang.String filterMacros(java.lang.String input,
                                        RenderContext renderContext,
                                        boolean isMatchedTags)

handleMatch

public void handleMatch(java.lang.StringBuffer buffer,
                        JdkMatchResult result,
                        RenderContext renderContext)
Description copied from class: RegexTokenFilter
Method is called for every occurnce of a regular expression. Subclasses have to implement this method.

Specified by:
handleMatch in class RegexTokenFilter
Parameters:
buffer - Buffer to write replacement string to
result - Hit with the found regular expression
renderContext - FilterContext for filters

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.