info.bliki.wiki.template
Class AbstractTemplateFunction

java.lang.Object
  info.bliki.wiki.template.AbstractTemplateFunction

All Implemented Interfaces:

ITemplateFunction

Direct Known Subclasses:

If, Ifeq

public class AbstractTemplateFunction
extends java.lang.Object
implements ITemplateFunction

A template parser function for {{ #if: ... }} syntax

Field Summary

static ITemplateFunction

CONST

Constructor Summary

AbstractTemplateFunction()

Method Summary

java.lang.String	getFunctionDoc() Return a short description of the implemented template function
java.lang.String	parseFunction(char[] src, int beginIndex, int endIndex, IWikiModel model) Parse a template function (like for example {{ #if: ... }}) The result is also a text string in Wikipedia syntax notation which will be parsed again (recursively) in the TemplateParser step.

Methods inherited from class java.lang.Object

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

Field Detail

CONST

public static final ITemplateFunction CONST

Constructor Detail

AbstractTemplateFunction

public AbstractTemplateFunction()

Method Detail

parseFunction

public java.lang.String parseFunction(char[] src,
                                      int beginIndex,
                                      int endIndex,
                                      IWikiModel model)

Description copied from interface: ITemplateFunction

Parse a template function (like for example {{ #if: ... }}) The result is also a text string in Wikipedia syntax notation which will be parsed again (recursively) in the TemplateParser step.

Specified by:

parseFunction in interface ITemplateFunction

Parameters:

src - the array of the current Wikipedia source text

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

model - the wiki model

Returns:

the result string of this template function or null if the parsing fails or isn't valid

See Also:

TemplateParser#parseTemplate(StringBuffer)

getFunctionDoc

public java.lang.String getFunctionDoc()

Description copied from interface: ITemplateFunction

Return a short description of the implemented template function

Specified by:

getFunctionDoc in interface ITemplateFunction

Returns: