org.sweble.wikitext.engine

Class ParserFunctionBase

java.lang.Object

org.sweble.wikitext.engine.ParserFunctionBase

All Implemented Interfaces:

Serializable, Comparable<ParserFunctionBase>

Direct Known Subclasses:

BuiltInParserFunctions.ParserFunctionSafeSubst, Convert, CorePfnBehaviorSwitch, CorePfnFunction, CorePfnVariable, ParserFunctionsExtPfn

public abstract class ParserFunctionBase
extends Object
implements Serializable, Comparable<ParserFunctionBase>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParserFunctionBase.ParserFunctionAdapter
protected static class	ParserFunctionBase.ParserFunctionRef

Constructor Summary

Constructors

Constructor and Description
ParserFunctionBase(PfnArgumentMode argMode, boolean pageSwitch, String id) For un-marshaling only.
ParserFunctionBase(PfnArgumentMode argMode, String id) For un-marshaling only.
ParserFunctionBase(String id) For un-marshaling only.
ParserFunctionBase(WikiConfig wikiConfig, PfnArgumentMode argMode, boolean pageSwitch, String id)
ParserFunctionBase(WikiConfig wikiConfig, PfnArgumentMode argMode, String id)
ParserFunctionBase(WikiConfig wikiConfig, String id)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ParserFunctionBase o)
boolean	equals(Object obj)
PfnArgumentMode	getArgMode()
String	getId()
WikiConfig	getWikiConfig()
int	hashCode()
abstract WtNode	invoke(WtNode template, ExpansionFrame preprocessorFrame, List<? extends WtNode> argsValues) WtNode can either be a WtTemplate or a WtPageSwitch
boolean	isPageSwitch()
protected EngineNodeFactory	nf()
void	setWikiConfig(WikiConfig wikiConfig) For internal use only!
String	toString()
protected EngineAstTextUtils	tu()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParserFunctionBase

public ParserFunctionBase(String id)

For un-marshaling only.

ParserFunctionBase

public ParserFunctionBase(PfnArgumentMode argMode,
                          String id)

For un-marshaling only.

ParserFunctionBase

public ParserFunctionBase(PfnArgumentMode argMode,
                          boolean pageSwitch,
                          String id)

For un-marshaling only.

ParserFunctionBase

public ParserFunctionBase(WikiConfig wikiConfig,
                          String id)

ParserFunctionBase

public ParserFunctionBase(WikiConfig wikiConfig,
                          PfnArgumentMode argMode,
                          String id)

ParserFunctionBase

public ParserFunctionBase(WikiConfig wikiConfig,
                          PfnArgumentMode argMode,
                          boolean pageSwitch,
                          String id)

Method Detail

setWikiConfig

public void setWikiConfig(WikiConfig wikiConfig)

For internal use only!

getWikiConfig

public WikiConfig getWikiConfig()

getId

public String getId()

getArgMode

public PfnArgumentMode getArgMode()

isPageSwitch

public boolean isPageSwitch()

nf

protected EngineNodeFactory nf()

tu

protected EngineAstTextUtils tu()

invoke

public abstract WtNode invoke(WtNode template,
                              ExpansionFrame preprocessorFrame,
                              List<? extends WtNode> argsValues)

WtNode can either be a WtTemplate or a WtPageSwitch

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ParserFunctionBase o)

Specified by:

compareTo in interface Comparable<ParserFunctionBase>

toString

public String toString()

Overrides:

toString in class Object