Package org.apache.commons.configuration2.tree

Class DefaultExpressionEngineSymbols

java.lang.Object

org.apache.commons.configuration2.tree.DefaultExpressionEngineSymbols

public final class DefaultExpressionEngineSymbols
extends java.lang.Object

A class representing the various symbols that are supported in keys recognized by DefaultExpressionEngine.

An instance of this class is associated with each instance of DefaultExpressionEngine. It determines which concrete symbols are used to define elements like separators, attributes, etc. within a configuration key.

Instances are created using the nested Builder class. They are immutable and can be shared between arbitrary components.

Since:

2.0

Version:

$Id: DefaultExpressionEngineSymbols.java 1624601 2014-09-12 18:04:36Z oheger $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultExpressionEngineSymbols.Builder	A builder class for creating instances of DefaultExpressionEngineSymbols.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_ATTRIBUTE_END	Constant for the default attribute end marker.
static java.lang.String	DEFAULT_ATTRIBUTE_START	Constant for the default attribute start marker.
static java.lang.String	DEFAULT_ESCAPED_DELIMITER	Constant for the default escaped property delimiter.
static java.lang.String	DEFAULT_INDEX_END	Constant for the default index end marker.
static java.lang.String	DEFAULT_INDEX_START	Constant for the default index start marker.
static java.lang.String	DEFAULT_PROPERTY_DELIMITER	Constant for the default property delimiter.
static DefaultExpressionEngineSymbols	DEFAULT_SYMBOLS	An instance with default symbols.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Compares this object with another one.
java.lang.String	getAttributeEnd()	Returns the string representing an attribute end marker.
java.lang.String	getAttributeStart()	Returns the string representing an attribute start marker.
java.lang.String	getEscapedDelimiter()	Returns the string representing an escaped property delimiter.
java.lang.String	getIndexEnd()	Returns the string representing the end of an index in a property key.
java.lang.String	getIndexStart()	Returns the string representing the start of an index in a property key.
java.lang.String	getPropertyDelimiter()	Returns the string used as delimiter in property keys.
int	hashCode()	Returns a hash code for this object.
java.lang.String	toString()	Returns a string representation for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PROPERTY_DELIMITER

public static final java.lang.String DEFAULT_PROPERTY_DELIMITER

Constant for the default property delimiter.

See Also:

Constant Field Values

DEFAULT_ESCAPED_DELIMITER

public static final java.lang.String DEFAULT_ESCAPED_DELIMITER

Constant for the default escaped property delimiter.

See Also:

Constant Field Values

DEFAULT_ATTRIBUTE_START

public static final java.lang.String DEFAULT_ATTRIBUTE_START

Constant for the default attribute start marker.

See Also:

Constant Field Values

DEFAULT_ATTRIBUTE_END

public static final java.lang.String DEFAULT_ATTRIBUTE_END

Constant for the default attribute end marker.

See Also:

Constant Field Values

DEFAULT_INDEX_START

public static final java.lang.String DEFAULT_INDEX_START

Constant for the default index start marker.

See Also:

Constant Field Values

DEFAULT_INDEX_END

public static final java.lang.String DEFAULT_INDEX_END

Constant for the default index end marker.

See Also:

Constant Field Values

DEFAULT_SYMBOLS

public static final DefaultExpressionEngineSymbols DEFAULT_SYMBOLS

An instance with default symbols. This instance is used by the default instance of DefaultExpressionEngine.

Method Detail

getPropertyDelimiter

public java.lang.String getPropertyDelimiter()

Returns the string used as delimiter in property keys.

Returns:

the property delimiter

getEscapedDelimiter

public java.lang.String getEscapedDelimiter()

Returns the string representing an escaped property delimiter.

Returns:

the escaped property delimiter

getAttributeStart

public java.lang.String getAttributeStart()

Returns the string representing an attribute start marker.

Returns:

the attribute start marker

getAttributeEnd

public java.lang.String getAttributeEnd()

Returns the string representing an attribute end marker.

Returns:

the attribute end marker

getIndexStart

public java.lang.String getIndexStart()

Returns the string representing the start of an index in a property key.

Returns:

the index start marker

getIndexEnd

public java.lang.String getIndexEnd()

Returns the string representing the end of an index in a property key.

Returns:

the index end marker

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code

equals

public boolean equals(java.lang.Object obj)

Compares this object with another one. Two instances of DefaultExpressionEngineSymbols are considered equal if all of their properties are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to

Returns:

a flag whether these objects are equal

toString

public java.lang.String toString()

Returns a string representation for this object. This string contains the values of all properties.

Overrides:

toString in class java.lang.Object

Returns:

a string for this object