com.asakusafw.runtime.util

Class VariableTable

java.lang.Object

com.asakusafw.runtime.util.VariableTable

public class VariableTable
extends Object

Parses strings which may contain variables.

This can parse a string that contain variable in form of ${variable-name}, and substitute them with defined variables by using defineVariable(String, String), etc.

Since:

0.1.0

Version:

0.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableTable.RedefineStrategy Represents strategies for redefining variables.

Constructor Summary

Constructors

Constructor and Description
VariableTable() Creates a new empty instance.
VariableTable(VariableTable.RedefineStrategy redefineStrategy) Creates a new empty instance.

Method Summary

Modifier and Type	Method and Description
static Set<String>	collectVariableNames(String string) Collects variable names in the target string.
void	defineVariable(String name, String replacement) Adds a new variable into this.
void	defineVariables(Map<String,String> variableMap) Adds new variables into this.
void	defineVariables(String variableList) Adds variables from the serialized variable table.
Map<String,String>	getVariables() Returns the variables names and their replacements in this table.
String	parse(String string) Substitutes variables in the string and returns the substituted one.
String	parse(String string, boolean strict) Substitutes variables in the string and returns the substituted one.
String	toSerialString() Serializes this variable table.
String	toString()
static String	toVariable(String name) Returns the variable expression for this parser.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableTable

public VariableTable()

Creates a new empty instance. This instance does not allow redefine any variables, or raises exceptions in such cases.

VariableTable

public VariableTable(VariableTable.RedefineStrategy redefineStrategy)

Creates a new empty instance.

Parameters:

redefineStrategy - a strategy for redefining variables

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

toVariable

public static String toVariable(String name)

Returns the variable expression for this parser.

Parameters:

name - the variable name

Returns:

the variable expression for the specified name

Throws:

IllegalArgumentException - if the variable name is not valid

defineVariable

public void defineVariable(String name,
                           String replacement)

Adds a new variable into this.

Parameters:

name - the variable name

replacement - the replacement

Throws:

IllegalArgumentException - if this rejects the target variable, or some parameters are null

defineVariables

public void defineVariables(Map<String,String> variableMap)

Adds new variables into this.

Parameters:

variableMap - the variable map (name -> value)

Throws:

IllegalArgumentException - if this rejects some variables, or some parameters are null

Since:

0.2.2

toSerialString

public String toSerialString()

Serializes this variable table. Clients can restore variables using defineVariables(String).

Returns:

the serialized value

See Also:

defineVariables(String)

defineVariables

public void defineVariables(String variableList)

Adds variables from the serialized variable table. The serialized string must be a form as like following:

VariableList:
    VariableList "," Variable
    Variable
    ","
    (Empty)

Variable:
    Value_key "=" Value_value

Value:
    Character*

Character:
    any character except ",", "=", "\\"
    "\" any character

Parameters:

variableList - the serialized variable table

Throws:

IllegalArgumentException - if this rejects some variables, or some parameters are null

getVariables

public Map<String,String> getVariables()

Returns the variables names and their replacements in this table.

Returns:

the variable map

parse

public String parse(String string)

Substitutes variables in the string and returns the substituted one.

Parameters:

string - the target string

Returns:

the substituted string

Throws:

IllegalArgumentException - if the string contains some undefined variables, or it is null

See Also:

defineVariable(String, String)

parse

public String parse(String string,
                    boolean strict)

Substitutes variables in the string and returns the substituted one.

Parameters:

string - the target string

strict - true to raise error if the string contain undefined variables, or false to leave such variables

Returns:

the substituted string

Throws:

IllegalArgumentException - if the string contains some undefined variables (only if strict mode), or it is null

See Also:

defineVariable(String, String)

collectVariableNames

public static Set<String> collectVariableNames(String string)

Collects variable names in the target string.

Parameters:

string - the target string (nullable)

Returns:

the found variable names

Since:

0.8.0

toString

public String toString()

Overrides:

toString in class Object