pl.jalokim.utils.template

Class TemplateAsText

java.lang.Object

pl.jalokim.utils.template.TemplateAsText

public final class TemplateAsText
extends Object

Utils class for some text with template, can override some placeholders. It can throw exception when some placeholder is not resolved. But to enable this please create instance of TemplateAsText by one of method which contains throwExceptionForNotResolved flag and set it to true. When throw exception is set to true then Every text like ${name_of_placeholder} will be recognized as placeholder when name of place holder contains [a-zA-Z_0-9] when contains all letters from 'a' to 'z' and from 'A' to 'Z' and contains number, or sign '_' and '-'

Method Summary

Modifier and Type	Method and Description
static TemplateAsText	fromClassPath(String resourcePath) Load text with placeholders from classpath.
static TemplateAsText	fromClassPath(String resourcePath, boolean throwExceptionForNotResolved) Load text with placeholders from classpath and set flag for throwExceptionForNotResolved.
static TemplateAsText	fromFile(String filePath) Load text with placeholders from file from certain file path.
static TemplateAsText	fromFile(String filePath, boolean throwExceptionForNotResolved) Load text with placeholders from file from certain file path and set flag for throwExceptionForNotResolved.
static TemplateAsText	fromText(String templateText) Load text with placeholders from simple String object.
static TemplateAsText	fromText(String templateText, boolean throwExceptionForNotResolved) * Load text with placeholders from simple String object and set flag for throwExceptionForNotResolved.
String	getCurrentTemplateText() Returns value for already resolved placeholders.
void	overrideVariable(String varName, String value) Override some placeholder.

Methods inherited from class java.lang.Object

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

Method Detail

fromClassPath

public static TemplateAsText fromClassPath(String resourcePath)

Load text with placeholders from classpath.

Parameters:

resourcePath - name of resource

Returns:

instance of TemplateAsText

fromClassPath

public static TemplateAsText fromClassPath(String resourcePath,
                                           boolean throwExceptionForNotResolved)

Load text with placeholders from classpath and set flag for throwExceptionForNotResolved.

Parameters:

resourcePath - name of resource

throwExceptionForNotResolved - it setup that will be throw exception when will not resolved all placeholder during invoke getCurrentTemplateText()

Returns:

instance of TemplateAsText

fromFile

public static TemplateAsText fromFile(String filePath)

Load text with placeholders from file from certain file path.

Parameters:

filePath - path for file

Returns:

instance of TemplateAsText

fromFile

public static TemplateAsText fromFile(String filePath,
                                      boolean throwExceptionForNotResolved)

Load text with placeholders from file from certain file path and set flag for throwExceptionForNotResolved.

Parameters:

filePath - path for file

throwExceptionForNotResolved - it setup that will be throw exception when will not resolved all placeholder during invoke getCurrentTemplateText()

Returns:

instance of TemplateAsText

fromText

public static TemplateAsText fromText(String templateText)

Load text with placeholders from simple String object.

Parameters:

templateText - text with placeholders

Returns:

instance of TemplateAsText

fromText

public static TemplateAsText fromText(String templateText,
                                      boolean throwExceptionForNotResolved)

* Load text with placeholders from simple String object and set flag for throwExceptionForNotResolved.

Parameters:

templateText - text with placeholders

throwExceptionForNotResolved - it setup that will be throw exception when will not resolved all placeholder during invoke getCurrentTemplateText()

Returns:

instance of TemplateAsText

overrideVariable

public void overrideVariable(String varName,
                             String value)

Override some placeholder.

Parameters:

varName - value of placeholder name

value - value for setup.

getCurrentTemplateText

public String getCurrentTemplateText()

Returns value for already resolved placeholders.

Returns:

text with already resolved placeholders or throw exception when some placeholder not resolved only when throwExceptionForNotResolved is set to true.