Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.community.renderer
Class BaseFilter

java.lang.Object
  extended by com.jivesoftware.community.renderer.AbstractRenderFilter
      extended by com.jivesoftware.community.renderer.BaseFilter
All Implemented Interfaces:
RenderFilter, com.jivesoftware.community.renderer.RenderPlugin

public abstract class BaseFilter
extends AbstractRenderFilter

A Base class to be used to create a filter. Subclasses of this macro can be configured by using annotions;

See Also:
Name, Description, EnableByDefault, RenderType

Constructor Summary
BaseFilter()
           
 
Method Summary
protected static java.lang.String applyFreemarkerTemplate(freemarker.template.Configuration config, java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String templateName)
          Processes the specified template file and returns a String containing the content of the template file.
protected  java.lang.String[] getDefaultHelp()
          Not currently used.
protected  java.util.Map<java.lang.String,java.lang.String[]> getDocumentationMap()
          Not currently used.
 java.lang.String getName()
          Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().
protected  boolean isEnabledByDefault()
          Returns the value of the EnableByDefault annotation if it is defined, else true.
 
Methods inherited from class com.jivesoftware.community.renderer.AbstractRenderFilter
getOrder, getParameters, getUserDocumentation, isDisplayable, isEnabled, isModifiable, setEnabled, setParameters, shouldProcess
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.jivesoftware.community.renderer.RenderFilter
execute
 

Constructor Detail

BaseFilter

public BaseFilter()
Method Detail

getName

public java.lang.String getName()
Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().

Specified by:
getName in interface com.jivesoftware.community.renderer.RenderPlugin
Specified by:
getName in class AbstractRenderFilter
Returns:
The name of the macro.

isEnabledByDefault

protected boolean isEnabledByDefault()
Returns the value of the EnableByDefault annotation if it is defined, else true.

Specified by:
isEnabledByDefault in class AbstractRenderFilter
Returns:
Whether or not the plugin is enabled by default.

getDocumentationMap

protected java.util.Map<java.lang.String,java.lang.String[]> getDocumentationMap()
Not currently used.

Specified by:
getDocumentationMap in class AbstractRenderFilter
Returns:
Returns null.

getDefaultHelp

protected java.lang.String[] getDefaultHelp()
Not currently used.

Specified by:
getDefaultHelp in class AbstractRenderFilter
Returns:
Returns an open string array.

applyFreemarkerTemplate

protected static java.lang.String applyFreemarkerTemplate(freemarker.template.Configuration config,
                                                          java.util.Map<java.lang.String,java.lang.Object> properties,
                                                          java.lang.String templateName)
Processes the specified template file and returns a String containing the content of the template file.

Parameters:
config - the freemarker configuration
properties - used for the freemarker context
templateName - name of the template
Returns:
the content of the specified template file

Jive Product Page

Copyright © 1999-2007 Jive Software.