org.pfsw.textx

Class BasicVariableContainer

java.lang.Object

org.pfsw.textx.BasicVariableContainer

All Implemented Interfaces:

VariableContainer, VariableResolver

public class BasicVariableContainer
extends java.lang.Object
implements VariableContainer

This is a basic implementation of the interface VariableResolver. It provides a container for a simple mapping of variable name to their corresponding values.

Constructor Summary

Constructors

Constructor and Description
BasicVariableContainer() Initialize the new instance with default values.
BasicVariableContainer(java.util.Map<java.lang.String,java.lang.Object> mapping) Initialize the new instance with the given mapping.
BasicVariableContainer(java.util.Properties properties) Initialize the new instance with the given properties.

Method Summary

Modifier and Type	Method and Description
void	addFrom(java.util.Map<java.lang.String,java.lang.Object> vars) Adds all key value pairs from the given map to the variables, if the key is a String.
protected java.util.Map<java.lang.String,java.lang.Object>	createNewMapping() Returns a new instance for the mapping.
java.lang.Object	getValue(java.lang.String varName) Returns the value for the variable with the given name.
protected java.util.Map<java.lang.String,java.lang.Object>	getVariableMapping()
boolean	isKnownVariable(java.lang.String varName) Returns if the variable with the given name can be resolved by the receiver.
java.util.Set<java.lang.String>	knownVariableNames() Returns all variable name the resolver currently knows
void	removeVariable(java.lang.String varName) Remove the variable with the specified name.
void	setValue(java.lang.String varName, java.lang.String value) Sets the value of the variable with the given name.
void	setValueFor(java.lang.String varName, boolean value) Sets the boolean value of the variable with the given name.
void	setValueFor(java.lang.String varName, java.lang.Object value) Sets the value of the variable with the given name.
protected void	setVariableMapping(java.util.Map<java.lang.String,? extends java.lang.Object> aValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicVariableContainer

public BasicVariableContainer()

Initialize the new instance with default values.
Subclasses that override this constructor must call super() first, before doing anything else.

BasicVariableContainer

public BasicVariableContainer(java.util.Map<java.lang.String,java.lang.Object> mapping)

Initialize the new instance with the given mapping.

Parameters:

mapping - The instance of a Map interface compliant class.

BasicVariableContainer

public BasicVariableContainer(java.util.Properties properties)

Initialize the new instance with the given properties.

Parameters:

properties - The properties to initialize the new instance with (must not be null).

Method Detail

knownVariableNames

public java.util.Set<java.lang.String> knownVariableNames()

Returns all variable name the resolver currently knows

Specified by:

knownVariableNames in interface VariableResolver

getValue

public java.lang.Object getValue(java.lang.String varName)
                          throws UnknownVariableException

Returns the value for the variable with the given name.

Specified by:

getValue in interface VariableResolver

Parameters:

varName - The case sensitive name of the variable.

Returns:

The value associated to the given variable (even null is a valid value)

Throws:

UnknownVariableException - The receiver is not knowing the variable.

isKnownVariable

public boolean isKnownVariable(java.lang.String varName)

Returns if the variable with the given name can be resolved by the receiver.

Specified by:

isKnownVariable in interface VariableResolver

Parameters:

varName - The case sensitive name of the variable.

Returns:

Whether the variable with the given name is known or not.

setValueFor

public void setValueFor(java.lang.String varName,
                        java.lang.Object value)

Sets the value of the variable with the given name.

Specified by:

setValueFor in interface VariableContainer

Parameters:

varName - The case sensitive name of the variable. Must not be null !

value - The new value of the variable. Must not be null !

setValueFor

public void setValueFor(java.lang.String varName,
                        boolean value)

Sets the boolean value of the variable with the given name.

Parameters:

varName - The case sensitive name of the variable. Must not be null !

value - The boolean value

setValue

public void setValue(java.lang.String varName,
                     java.lang.String value)

Sets the value of the variable with the given name.

Specified by:

setValue in interface VariableContainer

Parameters:

varName - The case sensitive name of the variable. Must not be null !

value - The new value of the variable. Must not be null !

removeVariable

public void removeVariable(java.lang.String varName)

Remove the variable with the specified name.

Specified by:

removeVariable in interface VariableContainer

Parameters:

varName - The name of the variable to be removed

addFrom

public void addFrom(java.util.Map<java.lang.String,java.lang.Object> vars)

Adds all key value pairs from the given map to the variables, if the key is a String.

createNewMapping

protected java.util.Map<java.lang.String,java.lang.Object> createNewMapping()

Returns a new instance for the mapping.
Subclasses may override this method to support a different mapping class.

Returns:

A new instance of a Map compliant class.

getVariableMapping

protected java.util.Map<java.lang.String,java.lang.Object> getVariableMapping()

setVariableMapping

protected void setVariableMapping(java.util.Map<java.lang.String,? extends java.lang.Object> aValue)