org.pfsw.textx

Class GlobalLocalPlaceholderReplacement

java.lang.Object

org.pfsw.textx.GlobalLocalVariables

org.pfsw.textx.GlobalLocalPlaceholderReplacement

All Implemented Interfaces:

VariableContainer, VariableResolver

public class GlobalLocalPlaceholderReplacement
extends GlobalLocalVariables

Contains all variable settings and provides a mechanism, to replace variable names in a text by their current value.

Constructor Summary

Constructors

Constructor and Description
GlobalLocalPlaceholderReplacement() Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
FunctionResolver	getFunctionResolver() Returns the function resolver
TextEngine	getTextEngine() Returns the underlying text engine which might be useful to do further configuration settings.
java.lang.String	replace(java.lang.String text) Replaces all known variables in the given text and returns the new string.
void	setFunctionResolver(FunctionResolver functionResolver) Sets the function resolver
protected void	setTextEngine(TextEngine newValue)

Methods inherited from class org.pfsw.textx.GlobalLocalVariables

getGlobalVars, getLocalVars, getValue, globalVariables, isKnownVariable, knownVariableNames, localVariables, newGlobalContext, newLocalContext, removeVariable, set, setGlobal, setGlobalFrom, setGlobalObject, setGlobalVars, setLocal, setLocalFrom, setLocalObject, setLocalVars, setValue, setValueFor, setVariablesFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalLocalPlaceholderReplacement

public GlobalLocalPlaceholderReplacement()

Initialize the new instance with default values.

Method Detail

replace

public java.lang.String replace(java.lang.String text)
                         throws TextReplacementException

Replaces all known variables in the given text and returns the new string.

Throws:

TextReplacementException

getTextEngine

public TextEngine getTextEngine()

Returns the underlying text engine which might be useful to do further configuration settings.

getFunctionResolver

public FunctionResolver getFunctionResolver()

Returns the function resolver

setFunctionResolver

public void setFunctionResolver(FunctionResolver functionResolver)

Sets the function resolver

setTextEngine

protected void setTextEngine(TextEngine newValue)