js.util

Class TextTemplate

java.lang.Object

js.util.TextTemplate

public class TextTemplate
extends Object

Text template with variables. Text template with standard ${...} variables. This class uses VariablesWriter for actual variables injection.

Using this class is trivial: create template instance, wrapping a given template string with variables, and uses put(String, Object) to replace variables with values. When complete uses toString() to get string with variables replaced.

 TextTemplate parameters = new TextTemplate(template);
 parameters.put("fax-number", faxNumber);
 parameters.put("email-address", emailAddress);
 ...
 // do something with parameters.toString()
 

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private static Log	log Class logger.
private String	template Source template string with variables.
private Map<String,String>	variables Variables map.

Constructor Summary

Constructors

Constructor and Description
TextTemplate(String template) Construct text template instance for given string with ${...} variable place holders.

Method Summary

Modifier and Type	Method and Description
void	put(String name, Object value) Set variables value.
String	toString() Inject variables into template and return resulting string.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Log log

Class logger.

template

private String template

Source template string with variables.

variables

private Map<String,String> variables

Variables map. Variables value objects are converted to string before storing in this map.

Constructor Detail

TextTemplate

public TextTemplate(String template)

Construct text template instance for given string with ${...} variable place holders.

Parameters:

template - string with variable place holders.

Method Detail

put

public void put(String name,
                Object value)

Set variables value. If variable name already exists its value is overridden. Convert variable value to string before storing to variables map. Null is not accepted for either variable name or its value.

This method uses Converter to convert variable value to string. If there is no converter able to handle given variable value type this method rise exception.

Parameters:

name - variable name,

value - variable value.

Throws:

IllegalArgumentException - if variable name is null or empty or value is null.

ConverterException - if there is no converter able to handle given value type.

toString

public String toString()

Inject variables into template and return resulting string. This method reflects current status of the variables map. If variables map is not completely initialized resulting string will still have ${...} variable marks.

Overrides:

toString in class Object