A simple class that supports creation of and iteration on configuration keys
supported by a DefaultExpressionEngine object.
For key creation the class works similar to a StringBuffer: There are several
appendXXXX() methods with which single parts of a key can be
constructed. All these methods return a reference to the actual object so
they can be written in a chain. When using this methods the exact syntax for
keys need not be known.
This class also defines a specialized iterator for configuration keys. With
such an iterator a key can be tokenized into its single parts. For each part
it can be checked whether it has an associated index.
Instances of this class are always associated with an instance of
DefaultExpressionEngine, from which the current
delimiters are obtained. So key creation and parsing is specific to this
associated expression engine.
Creates a new instance of DefaultConfigurationKey and sets
the associated expression engine and an initial key.
Parameters: engine - the expression engine Parameters: key - the key to be wrapped
Appends the name of a property to this key. If necessary, a property
delimiter will be added. If the boolean argument is set to true,
property delimiters contained in the property name will be escaped.
Parameters: property - the name of the property to be added Parameters: escape - a flag if property delimiters in the passed in property nameshould be escaped a reference to this object
Appends the name of a property to this key. If necessary, a property
delimiter will be added. Property delimiters in the given string will not
be escaped.
Parameters: property - the name of the property to be added a reference to this object
Extracts the name of the attribute from the given attribute key. This
method removes the attribute markers - if any - from the specified key.
Parameters: key - the attribute key the name of the corresponding attribute
Decorates the given key so that it represents an attribute. Adds special
start and end markers. The passed in string will be modified only if does
not already represent an attribute.
Parameters: key - the key to be decorated the decorated attribute key
Checks if two ConfigurationKey objects are equal. The
method can be called with strings or other objects, too.
Parameters: c - the object to compare a flag if both objects are equal
Tests if the specified key represents an attribute according to the
current expression engine.
Parameters: key - the key to be checked true if this is an attribute key, false otherwise
Sets the new length of this configuration key. With this method it is
possible to truncate the key, e.g. to return to a state prior calling
some append() methods. The semantic is the same as the
setLength() method of StringBuffer.
Parameters: len - the new length of the key