org.perfcake.util

Class StringTemplate

java.lang.Object

org.perfcake.util.StringTemplate

All Implemented Interfaces:

Serializable

public class StringTemplate
extends Object
implements Serializable

Holds a template capable of replacing properties in form of ${property} and @{property} to their values. The properties with the dollar sign are replaced only once, while the properties with the "at" sign are replaced with each call to toString(Properties) with the current values (this simulates JavaEE EL). System properties can be accessed using the props. prefix, and environment properties can be accessed using the env. prefix. Automatically provides environment properties, system properties and user specified properties. Default values are separated by semicolon (e.g. ${property:defaultValue}). The property name must contain only letters, numbers and underscores (this is not strictly checked but may lead to undefined behaviour). Backslash works as a general escape character and escapes any letter behind it (e.g. \\ is replaced by \, \@ is replaced by @ etc.). Examples: ${propertyA} ${non_existing:default} ${env.JAVA_HOME} ${props['java.runtime.name']} Notice: The first call to the constructor and calls to the static method parseTemplate(String, Properties) might take more time than a simple RegExp match but this is payed back for the subsequent calls to toString().

Author:

Martin Večeřa

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringTemplate(String template) Creates a template using the provided string interpretation.
StringTemplate(String template, Properties properties) Creates a template using the provided string interpretation using the additional properties.

Method Summary

Modifier and Type	Method and Description
boolean	hasDynamicPlaceholders() Were there any placeholders that need to be replaced each time when rendered?
boolean	hasPlaceholders() Were there any placeholders in the template?
static String	parseTemplate(String template, Properties properties) Gets the rendered template of the provided string interpretation and properties.
String	toString() Renders the template.
String	toString(Properties localProperties) Renders the template using the additionally provided properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringTemplate

public StringTemplate(String template)

Creates a template using the provided string interpretation.

Parameters:

template - The string interpretation of the pattern.

StringTemplate

public StringTemplate(String template,
                      Properties properties)

Creates a template using the provided string interpretation using the additional properties.

Parameters:

template - The string interpretation of the pattern.

properties - Properties to be immediately replaced in the template.

Method Detail

hasPlaceholders

public boolean hasPlaceholders()

Were there any placeholders in the template?

Returns:

True if and only if there were any placeholders in the template.

hasDynamicPlaceholders

public boolean hasDynamicPlaceholders()

Were there any placeholders that need to be replaced each time when rendered?

Returns:

True if and only if there were any placeholders that need to be replaced each time when rendered.

toString

public String toString()

Renders the template.

Overrides:

toString in class Object

Returns:

The rendered template.

toString

public String toString(Properties localProperties)

Renders the template using the additionally provided properties.

Parameters:

localProperties - The additional properties to be replaced in the template.

Returns:

The rendered template.

parseTemplate

public static String parseTemplate(String template,
                                   Properties properties)

Gets the rendered template of the provided string interpretation and properties.

Parameters:

template - The string representation of the template.

properties - The properties to be replaced in the template.

Returns:

The rendered template.