info.bliki.wiki.template

Class Subst

java.lang.Object

info.bliki.wiki.template.AbstractTemplateFunction

info.bliki.wiki.template.Safesubst

info.bliki.wiki.template.Subst

All Implemented Interfaces:

ITemplateFunction

public class Subst
extends Safesubst

A template parser function for {{subst: ... }}. See Wikipedia-Help:Substitution

Field Summary

Fields

Modifier and Type	Field and Description
static ITemplateFunction	CONST

Constructor Summary

Constructors

Constructor and Description
Subst()

Method Summary

Modifier and Type	Method and Description
String	parseFunction(List<String> parts1, IWikiModel model, char[] src, int beginIndex, int endIndex, boolean isSubst) Parse a template function (like for example {{ #if: ...

Methods inherited from class info.bliki.wiki.template.Safesubst

parsePreprocess

Methods inherited from class info.bliki.wiki.template.AbstractTemplateFunction

getFunctionDoc, parse, parseTrim

Methods inherited from class java.lang.Object

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

Field Detail

CONST

public static final ITemplateFunction CONST

Constructor Detail

Subst

public Subst()

Method Detail

parseFunction

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

Description copied from class: AbstractTemplateFunction

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

Overrides:

parseFunction in class Safesubst

Parameters:

parts1 - 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.

See Also:

TemplateParser#parseTemplate(StringBuffer)