de.k3b.util

Class StringTemplateEngine

java.lang.Object

de.k3b.util.StringTemplateEngine

public class StringTemplateEngine
extends java.lang.Object

Engine that replaces all occurences of ${name} with corresponding values from callback defined in StringTemplateEngine.IValueResolver.

new StringTemplate(valueResolver).format("hello ${first.name}!")

will produce “hello world!” if valueResolver.get(“first”,“name”) returns “world”

Created by k3b on 01.04.2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringTemplateEngine.IValueResolver callback for StringTemplateEngine to resolve the values for names.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Stack<java.lang.String>	debugStack if sedDebugEnabled(boolean) is set to true. this stack will contain debugbessages as callstack
protected StringTemplateEngine.IValueResolver	valueResolver used to convert ${name} to corresponding value

Constructor Summary

Constructors

Constructor and Description
StringTemplateEngine(StringTemplateEngine.IValueResolver valueResolver) creates the engine with StringTemplateEngine.IValueResolver.

Method Summary

Modifier and Type	Method and Description
protected void	debugPop() debug implementation: pop from stack: forget last debugPush(String).
protected void	debugPush(java.lang.String parameter) debug implementation: push to stack.
java.lang.String	format(java.lang.String template) translates tmeplate to string.
protected java.lang.String	getDebugStackTrace() show debug stacktrace, if sedDebugEnabled(boolean) is set to true.
java.lang.String	getErrors() get last error message.
protected boolean	hasParameters(java.lang.String value) return strue, if value contains tempate parameters
protected java.lang.String	onResolverResult(java.lang.String templateParameter, java.lang.String resolverResult) called for every parameter match.
StringTemplateEngine	sedDebugEnabled(boolean enabled) en- or disables debugging mode.

Methods inherited from class java.lang.Object

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

Field Detail

valueResolver

protected StringTemplateEngine.IValueResolver valueResolver

used to convert ${name} to corresponding value

debugStack

protected java.util.Stack<java.lang.String> debugStack

if sedDebugEnabled(boolean) is set to true. this stack will contain debugbessages as callstack

Constructor Detail

StringTemplateEngine

public StringTemplateEngine(StringTemplateEngine.IValueResolver valueResolver)

creates the engine with StringTemplateEngine.IValueResolver.

Method Detail

hasParameters

protected boolean hasParameters(java.lang.String value)

return strue, if value contains tempate parameters

format

public java.lang.String format(java.lang.String template)

translates tmeplate to string.

onResolverResult

protected java.lang.String onResolverResult(java.lang.String templateParameter,
                                            java.lang.String resolverResult)

called for every parameter match. Is used to collect debug infos.

sedDebugEnabled

public StringTemplateEngine sedDebugEnabled(boolean enabled)

en- or disables debugging mode.

debugPush

protected void debugPush(java.lang.String parameter)

debug implementation: push to stack.

debugPop

protected void debugPop()

debug implementation: pop from stack: forget last debugPush(String).

getDebugStackTrace

protected java.lang.String getDebugStackTrace()

show debug stacktrace, if sedDebugEnabled(boolean) is set to true.

getErrors

public java.lang.String getErrors()

get last error message. Error is cleared after reading message.