jodd.util

Class StringTemplateParser

java.lang.Object

jodd.util.StringTemplateParser

public class StringTemplateParser
extends java.lang.Object

Parser for string macro templates. On parsing, macro values in provided string are resolved and replaced with real values. Once set, one string template parser can be reused for parsing, even using different macro resolvers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringTemplateParser.MacroResolver Macro value resolver.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MACRO_END
static java.lang.String	DEFAULT_MACRO_PREFIX
static java.lang.String	DEFAULT_MACRO_START
protected char	escapeChar
protected java.lang.String	macroEnd
protected java.lang.String	macroPrefix
protected java.lang.String	macroStart
protected java.lang.String	missingKeyReplacement
protected boolean	parseValues
protected boolean	replaceMissingKey
protected boolean	resolveEscapes

Constructor Summary

Constructors

Constructor and Description
StringTemplateParser()

Method Summary

Modifier and Type	Method and Description
static StringTemplateParser	create() Static ctor.
static StringTemplateParser.MacroResolver	createMapMacroResolver(java.util.Map map) Creates commonly used StringTemplateParser.MacroResolver that resolved macros in the provided map.
char	getEscapeChar()
java.lang.String	getMacroEnd()
java.lang.String	getMacroPrefix()
java.lang.String	getMacroStart()
java.lang.String	getMissingKeyReplacement()
boolean	isParseValues()
boolean	isReplaceMissingKey()
boolean	isResolveEscapes()
java.lang.String	parse(java.lang.String template, StringTemplateParser.MacroResolver macroResolver) Parses string template and replaces macros with resolved values.
StringTemplateParser	setEscapeChar(char escapeChar) Defines escape character.
StringTemplateParser	setMacroEnd(java.lang.String macroEnd) Defines macro end string.
StringTemplateParser	setMacroPrefix(java.lang.String macroPrefix)
StringTemplateParser	setMacroStart(java.lang.String macroStart) Defines macro start string.
StringTemplateParser	setMissingKeyReplacement(java.lang.String missingKeyReplacement) Specifies replacement for missing keys.
StringTemplateParser	setParseValues(boolean parseValues) Defines if macro values has to be parsed, too.
void	setReplaceMissingKey(boolean replaceMissingKey) Specifies if missing keys should be resolved at all, true by default.
StringTemplateParser	setResolveEscapes(boolean resolveEscapes) Specifies if escaped values should be resolved.
StringTemplateParser	setStrictFormat() Sets the strict format by setting the macro prefix to null.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MACRO_PREFIX

public static final java.lang.String DEFAULT_MACRO_PREFIX

See Also:

Constant Field Values

DEFAULT_MACRO_START

public static final java.lang.String DEFAULT_MACRO_START

See Also:

Constant Field Values

DEFAULT_MACRO_END

public static final java.lang.String DEFAULT_MACRO_END

See Also:

Constant Field Values

replaceMissingKey

protected boolean replaceMissingKey

missingKeyReplacement

protected java.lang.String missingKeyReplacement

resolveEscapes

protected boolean resolveEscapes

macroPrefix

protected java.lang.String macroPrefix

macroStart

protected java.lang.String macroStart

macroEnd

protected java.lang.String macroEnd

escapeChar

protected char escapeChar

parseValues

protected boolean parseValues

Constructor Detail

StringTemplateParser

public StringTemplateParser()

Method Detail

create

public static StringTemplateParser create()

Static ctor.

isReplaceMissingKey

public boolean isReplaceMissingKey()

setReplaceMissingKey

public void setReplaceMissingKey(boolean replaceMissingKey)

Specifies if missing keys should be resolved at all, true by default. If false missing keys will be left as it were, i.e. they will not be replaced.

getMissingKeyReplacement

public java.lang.String getMissingKeyReplacement()

setMissingKeyReplacement

public StringTemplateParser setMissingKeyReplacement(java.lang.String missingKeyReplacement)

Specifies replacement for missing keys. If null exception will be thrown.

isResolveEscapes

public boolean isResolveEscapes()

setResolveEscapes

public StringTemplateParser setResolveEscapes(boolean resolveEscapes)

Specifies if escaped values should be resolved. In special usecases, when the same string has to be processed more then once, this may be set to false so escaped values remains.

getMacroStart

public java.lang.String getMacroStart()

setMacroStart

public StringTemplateParser setMacroStart(java.lang.String macroStart)

Defines macro start string.

getMacroPrefix

public java.lang.String getMacroPrefix()

setMacroPrefix

public StringTemplateParser setMacroPrefix(java.lang.String macroPrefix)

getMacroEnd

public java.lang.String getMacroEnd()

setMacroEnd

public StringTemplateParser setMacroEnd(java.lang.String macroEnd)

Defines macro end string.

setStrictFormat

public StringTemplateParser setStrictFormat()

Sets the strict format by setting the macro prefix to null.

getEscapeChar

public char getEscapeChar()

setEscapeChar

public StringTemplateParser setEscapeChar(char escapeChar)

Defines escape character.

isParseValues

public boolean isParseValues()

setParseValues

public StringTemplateParser setParseValues(boolean parseValues)

Defines if macro values has to be parsed, too. By default, macro values are returned as they are.

parse

public java.lang.String parse(java.lang.String template,
                              StringTemplateParser.MacroResolver macroResolver)

Parses string template and replaces macros with resolved values.

createMapMacroResolver

public static StringTemplateParser.MacroResolver createMapMacroResolver(java.util.Map map)

Creates commonly used StringTemplateParser.MacroResolver that resolved macros in the provided map.