info.bliki.wiki.template

Class AbstractTemplateFunction

java.lang.Object

info.bliki.wiki.template.AbstractTemplateFunction

All Implemented Interfaces:

ITemplateFunction

Direct Known Subclasses:

Allmacros, Anchorencode, DollarContext, Expr, FormatDate, Formatnum, Fullurl, If, Ifeq, Iferror, Ifexist, Ifexpr, Invoke, LC, LCFirst, Localurl, NS, Padleft, Padright, Plural, Safesubst, Switch, Tag, Time, Titleparts, UC, UCFirst, URLEncode

public abstract class AbstractTemplateFunction
extends Object
implements ITemplateFunction

An abstract template parser function.

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateFunction()

Method Summary

Modifier and Type	Method and Description
String	getFunctionDoc() Return a short description of the implemented template function
static String	parse(String content, IWikiModel model) Parse the given content string with the template parser.
abstract String	parseFunction(List<String> parts, IWikiModel model, char[] src, int beginIndex, int endIndex, boolean isSubst) Parse a template function (like for example {{ #if: ...
static String	parseTrim(String content, IWikiModel model) Parse the given content string with the template parser and trim() the resulting string.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTemplateFunction

public AbstractTemplateFunction()

Method Detail

getFunctionDoc

public String getFunctionDoc()

Description copied from interface: ITemplateFunction

Return a short description of the implemented template function

Specified by:

getFunctionDoc in interface ITemplateFunction

Returns:

parseFunction

public abstract String parseFunction(List<String> parts,
                                     IWikiModel model,
                                     char[] src,
                                     int beginIndex,
                                     int endIndex,
                                     boolean isSubst)
                              throws IOException

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:

parts - the parser function arguments (extracted from the wiki text by splitting the string at the pipe symbol ´|´)

model - the wiki model

src - the array of the current Wikipedia source text.

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

isSubst - if true the template function was called from subst or safesubst function and the arguments of the function are typically not parsed recursively.

Returns:

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

Throws:

IOException

See Also:

TemplateParser#parseTemplate(StringBuffer)

parse

public static String parse(String content,
                           IWikiModel model)

Parse the given content string with the template parser.

Parameters:

content - the raw content string

model - the wiki model

Returns:

parseTrim

public static String parseTrim(String content,
                               IWikiModel model)

Parse the given content string with the template parser and trim() the resulting string.

Parameters:

content - the raw content string

model - the wiki model

Returns: