alma.acs.commandcenter.util

Class VariableString

java.lang.Object

alma.acs.commandcenter.util.VariableString

public class VariableString
extends java.lang.Object

Purpose of this class is to resolve embedded variables in a source string like "${user.home}/config/${policydir}".

Invocation of the toString() method will resolve the embedded variables using the Java system properties. By using the toString(Map) method you can specify which dictionary to use. In both cases, the following holds: If a non-existing (or null-value) variable is encountered, it will either a) be resolved to the empty string, or b) an exception will be thrown. This depends on the boolean flag lenient.

Note: Relationship between PreparedString and VariableString: PreparedString uses positional parameters to replace placeholders with the elements of a string array. VariableString uses named parameters to replace placeholders with values from a map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VariableString.IResolver
static class	VariableString.UnresolvableException

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	lenient
protected java.lang.String	source

Constructor Summary

Constructors

Constructor and Description
VariableString(java.lang.String source) Constructs an instance with the given source, and a lenient way of dealing with unresolvable variables.
VariableString(java.lang.String source, boolean lenient) Constructs an instance with the given source.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSource() Returns the non-resolved (source) version of this instance.
protected java.lang.String	resolveVariables(VariableString.IResolver res, java.lang.String value) Performs the replacement of embedded variable names, recursively.
java.lang.String	toString() Returns a resolved version of this instance, resolving is done using the Java system properties.
java.lang.String	toString(java.util.Map<?,java.lang.Object> map) Returns a resolved version of this instance, resolving is done using the specified map.
java.lang.String	toString(VariableString.IResolver map) Returns a resolved version of this instance, resolving is done using the specified IResolver.

Methods inherited from class java.lang.Object

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

Field Detail

lenient

protected boolean lenient

source

protected java.lang.String source

Constructor Detail

VariableString

public VariableString(java.lang.String source)

Constructs an instance with the given source, and a lenient way of dealing with unresolvable variables.

Parameters:

source - string, e.g. "${user.home}/config/${policydir}".

VariableString

public VariableString(java.lang.String source,
                      boolean lenient)

Constructs an instance with the given source.

Parameters:

source - string, e.g. "${user.home}/config/${policydir}".

lenient - whether unresolvable variables will provoke an exception

Method Detail

getSource

public java.lang.String getSource()

Returns the non-resolved (source) version of this instance.

Returns:

the non-resolved (source) version of this instance.

toString

public java.lang.String toString()
                          throws VariableString.UnresolvableException

Returns a resolved version of this instance, resolving is done using the Java system properties.

Overrides:

toString in class java.lang.Object

Returns:

the resolved version of this instance.

Throws:

VariableString.UnresolvableException - if variables cannot be resolved and we are non-lenient

toString

public java.lang.String toString(java.util.Map<?,java.lang.Object> map)
                          throws VariableString.UnresolvableException

Returns a resolved version of this instance, resolving is done using the specified map.

Returns:

the resolved version of this instance.

Throws:

VariableString.UnresolvableException - if variables cannot be resolved and we are non-lenient

toString

public java.lang.String toString(VariableString.IResolver map)
                          throws VariableString.UnresolvableException

Returns a resolved version of this instance, resolving is done using the specified IResolver.

Returns:

the resolved version of this instance.

Throws:

VariableString.UnresolvableException - if variables cannot be resolved and we are non-lenient

resolveVariables

protected java.lang.String resolveVariables(VariableString.IResolver res,
                                            java.lang.String value)
                                     throws VariableString.UnresolvableException

Performs the replacement of embedded variable names, recursively. If a non-existing (or null-value) variable is encountered, this will either a) resolve to the empty string, or b) throw an exception, depending on the boolean flag lenient.

Throws:

VariableString.UnresolvableException