PropertyValue (Apache Tamaya Core API 0.4-incubating API)

java.lang.Object
- org.apache.tamaya.spi.PropertyValue

All Implemented Interfaces:

Serializable, Iterable<PropertyValue>

Direct Known Subclasses:

ListValue, ObjectValue
```
public class PropertyValue
extends Object
implements Serializable, Iterable<PropertyValue>
```
Class modelling the result of a request for a property createValue. A property createValue is basically identified by its key. There might be reasons, where one want to further analyze, which PropertySources provided a createValue and which not, so it is possible to createObject a PropertyValue with a null createValue. A PropertyValue represents an abstract data point in a configuration structure read. PropertyValues actually represent a tree, with additional functionality for representing data lists/arrays using indexed children names. This allows to support a full mapping of common document based configuration formats, such as JSON, YAML, XML and more.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PropertyValue.ValueType
Enum of the different supported value types.

Nested Classes
Modifier and Type	Class	Description
`static class`	`PropertyValue.ValueType`	Enum of the different supported value types.

Constructor Summary

Constructors
Modifier	Constructor	Description
	`PropertyValue(String key)`	Creates a new instance
`protected`	`PropertyValue(String key, String value)`	Creates a new instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected void`	`checkImmutable()`
`static ListValue`	`createList()`	Creates a new (invisible) root, which is a node with an empty name.
`static ListValue`	`createList(String key)`	Creates a new createValue of type `PropertyValue.ValueType.ARRAY`.
`static ObjectValue`	`createObject()`	Creates a new (invisible) root, which is a node with an empty name.
`static ObjectValue`	`createObject(String key)`	Creates a new createValue of type `PropertyValue.ValueType.MAP`.
`static PropertyValue`	`createValue(String key, String value)`	Creates a new createValue of type `PropertyValue.ValueType.VALUE`.
`protected PropertyValue`	`deepClone()`	Creates a deep clone of this intance.
`boolean`	`equals(Object o)`
`String`	`getKey()`	The requested key.
`Map<String,String>`	`getMeta()`	Creates a full configuration map for this key, createValue pair and all its getMeta context data.
`<T> T`	`getMeta(String key)`	Access the given key from this createValue.
`String`	`getMetaEntry(String key)`	Deprecated. Use `getMeta(String)` instead of.
`PropertyValue`	`getParent()`	Get the value's parent.
`String`	`getQualifiedKey()`	Get a qualified name of a value in property format using '.' as separator, e.g.
`int`	`getSize()`	Get the createValue's number of elements.
`String`	`getSource()`	Deprecated. Use `getMeta("source")`.
`String`	`getValue()`	Get the node's createValue.
`PropertyValue.ValueType`	`getValueType()`	Get the item's current createValue type.
`int`	`getVersion()`	Get the values version, the version is updated with each change written.
`int`	`hashCode()`
`PropertyValue`	`immutable()`	Sets this instance and also all its direct an indirect children to immutable.
`protected int`	`incrementVersion()`	Called to mark a change on this instance.
`boolean`	`isImmutable()`	Checks if the instance is immutable.
`boolean`	`isLeaf()`	Checks if the value is a leaf value (has no values).
`boolean`	`isRoot()`	Checks if the value is a root value.
`Iterator<PropertyValue>`	`iterator()`
`static Map<String,PropertyValue>`	`mapProperties(Map<String,String> config, String source)`	Maps a mapProperties of `Map<String,String>` to a `Map<String,PropertyValue>`.
`static Map<String,PropertyValue>`	`mapProperties(Map<String,String> config, String source, Map<String,String> metaData)`	Maps a mapProperties of `Map<String,String>` to a `Map<String,PropertyValue>`.
`static Map<String,PropertyValue>`	`mapProperties(Map<String,String> config, String source, Map<String,String> metaData, String prefix)`	Maps a mapProperties of `Map<String,String>` to a `Map<String,PropertyValue>`.
`PropertyValue`	`mutable()`	Clones this instance and all it's children, marking as mutable createValue.
`PropertyValue`	`removeMeta(String key)`	Removes a getMeta entry.
`PropertyValue`	`setKey(String key)`	Changes the entry's key, mapping also corresponding context entries.
`PropertyValue`	`setMeta(String key, Object value)`	Add an additional context data information.
`PropertyValue`	`setMeta(Map<String,String> metaEntries)`	Replaces/sets the context data.
`protected PropertyValue`	`setParent(PropertyValue parent)`	Sets the new parent, used iternally when converting between value types.
`PropertyValue`	`setValue(String value)`	Sets the createValue.
`protected void`	`setVersion(int version)`	Sets the new version, used iternally when cloning.
`ListValue`	`toListValue()`	Convert an instance to a List PropertyValue.
`Map<String,String>`	`toLocalMap()`	Convert the value tree to a property mapProperties using local keys.
`Map<String,String>`	`toMap()`	Convert the value tree to a property map.
`ObjectValue`	`toObjectValue()`	Convert an instance to a Object PropertyValue.
`String`	`toString()`	Create a String representation of the tree.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PropertyValue
```
public PropertyValue(String key)
```
    Creates a new instance
    
    Parameters:
    
    key - the key, not null.
  - PropertyValue
```
protected PropertyValue(String key,
                        String value)
```
    Creates a new instance
    
    Parameters:
    
    key - the key, not null.
    
    value - the initial text createValue.
- Method Detail
  - createObject
```
public static ObjectValue createObject()
```
    Creates a new (invisible) root, which is a node with an empty name.
    
    Returns:
    
    a new empty root, never null.
  - createList
```
public static ListValue createList()
```
    Creates a new (invisible) root, which is a node with an empty name.
    
    Returns:
    
    a new empty root, never null.
  - createValue
```
public static PropertyValue createValue(String key,
                                        String value)
```
    Creates a new createValue of type PropertyValue.ValueType.VALUE.
    
    Parameters:
    
    key - the key, not null.
    
    value - the createValue, not null.
    
    Returns:
    
    a new createValue instance.
  - createList
```
public static ListValue createList(String key)
```
    Creates a new createValue of type PropertyValue.ValueType.ARRAY.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    a new createValue instance.
  - createObject
```
public static ObjectValue createObject(String key)
```
    Creates a new createValue of type PropertyValue.ValueType.MAP.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    a new createValue instance.
  - mapProperties
```
public static Map<String,PropertyValue> mapProperties(Map<String,String> config,
                                                      String source)
```
    Maps a mapProperties of Map<String,String> to a Map<String,PropertyValue>.
    
    Parameters:
    
    config - the String based mapProperties, not null.
    
    source - the source name, not null.
    
    Returns:
    
    the corresponding createValue based mapProperties.
  - mapProperties
```
public static Map<String,PropertyValue> mapProperties(Map<String,String> config,
                                                      String source,
                                                      Map<String,String> metaData)
```
    Maps a mapProperties of Map<String,String> to a Map<String,PropertyValue>.
    
    Parameters:
    
    config - the String based mapProperties, not null.
    
    source - the source name, not null.
    
    metaData - additional metadata, not null.
    
    Returns:
    
    the corresponding createValue based mapProperties.
  - mapProperties
```
public static Map<String,PropertyValue> mapProperties(Map<String,String> config,
                                                      String source,
                                                      Map<String,String> metaData,
                                                      String prefix)
```
    Maps a mapProperties of Map<String,String> to a Map<String,PropertyValue>.
    
    Parameters:
    
    config - the String based mapProperties, not null.
    
    source - the source name, not null.
    
    metaData - additional metadata, not null.
    
    prefix - the prefix to add (optional).
    
    Returns:
    
    the corresponding createValue based mapProperties.
  - isImmutable
```
public final boolean isImmutable()
```
    Checks if the instance is immutable.
    
    Returns:
    
    true, if the instance is immutable.
  - immutable
```
public PropertyValue immutable()
```
    Sets this instance and also all its direct an indirect children to immutable. Any further changes will throw an IllegalStateException.
    
    Returns:
    
    this instance for chaining.
  - mutable
```
public PropertyValue mutable()
```
    Clones this instance and all it's children, marking as mutable createValue.
    
    Returns:
    
    the new createValue clone.
  - getValueType
```
public PropertyValue.ValueType getValueType()
```
    Get the item's current createValue type.
    
    Returns:
    
    the createValue type, never null.
  - getKey
```
public final String getKey()
```
    The requested key.
    
    Returns:
    
    the, key never null.
  - getValue
```
public String getValue()
```
    Get the node's createValue.
    
    Returns:
    
    the createValue, or null.
  - getSource
```
@Deprecated
public String getSource()
```
    Deprecated. Use getMeta("source").
    
    Get the source.
    
    Returns:
    
    the source, or null.
  - setValue
```
public PropertyValue setValue(String value)
```
    Sets the createValue.
    
    Parameters:
    
    value - the createValue
    
    Returns:
    
    this value for chaining.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    isImmutable()
  - getQualifiedKey
```
public String getQualifiedKey()
```
    Get a qualified name of a value in property format using '.' as separator, e.g. a.b.c or a.b.c[0] for indexed entries. Entries hereby also can have multiple levels of indexing, e.g. a[1].b.c[14].d is a valid option. The qualified key is defined by getQualifiedKey() of it's parent concatenated with the key of this node. If there is no parent, or the parent's qualified key is empty only getKey() is returned. Additionally if the current values is an indeyed createValue the key is extended by the index in brackets, e.g. [0], [1], .... All the subsequent keys are valid qualified keys:
```
     a
     a.b
     a[0].b
     [0]
     a.b[4].c.d[0].[1].any
 
```
    Returns:
    
    the qualified key, never null..
  - getParent
```
public final PropertyValue getParent()
```
    Get the value's parent.
    
    Returns:
    
    the parent, or null.
  - getVersion
```
public final int getVersion()
```
    Get the values version, the version is updated with each change written.
    
    Returns:
    
    the version.
  - isRoot
```
public final boolean isRoot()
```
    Checks if the value is a root value.
    
    Returns:
    
    true, if the current value is a root value.
  - isLeaf
```
public final boolean isLeaf()
```
    Checks if the value is a leaf value (has no values).
    
    Returns:
    
    true, if the current value is a leaf value.
  - getMeta
```
public final Map<String,String> getMeta()
```
    Creates a full configuration map for this key, createValue pair and all its getMeta context data. This map is also used for subsequent processing, like createValue filtering.
    
    Returns:
    
    the property createValue entry map.
  - getMetaEntry
```
@Deprecated
public String getMetaEntry(String key)
```
    Deprecated. Use getMeta(String) instead of.
    
    Access the given key from this createValue. Valid keys are the key or any getMeta-context key.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    the createValue found, or null.
  - getMeta
```
public final <T> T getMeta(String key)
```
    Access the given key from this createValue. Valid keys are the key or any getMeta-context key.
    
    Type Parameters:
    
    T - the target type.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    the createValue found, or null.
  - getSize
```
public int getSize()
```
    Get the createValue's number of elements.
    
    Returns:
    
    the getNumChilds of this multi createValue.
  - iterator
```
public Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface Iterable<PropertyValue>
  - setMeta
```
public final PropertyValue setMeta(Map<String,String> metaEntries)
```
    Replaces/sets the context data.
    
    Parameters:
    
    metaEntries - the context data to be applied, not null.
    
    Returns:
    
    the builder for chaining.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    isImmutable()
  - setMeta
```
public final PropertyValue setMeta(String key,
                                   Object value)
```
    Add an additional context data information.
    
    Parameters:
    
    key - the context data key, not null.
    
    value - the context createValue, not null (will be converted to String).
    
    Returns:
    
    the builder for chaining.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    isImmutable()
  - removeMeta
```
public final PropertyValue removeMeta(String key)
```
    Removes a getMeta entry.
    
    Parameters:
    
    key - the entry's key, not null.
    
    Returns:
    
    the builder for chaining.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    isImmutable()
  - toMap
```
public Map<String,String> toMap()
```
    Convert the value tree to a property map.
    
    Returns:
    
    the corresponding property map, not null.
  - toLocalMap
```
public Map<String,String> toLocalMap()
```
    Convert the value tree to a property mapProperties using local keys.
    
    Returns:
    
    the corresponding property mapProperties, not null.
  - toString
```
public String toString()
```
    Create a String representation of the tree.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the corresponding String representation, not null.
  - toObjectValue
```
public ObjectValue toObjectValue()
```
    Convert an instance to a Object PropertyValue.
    
    Returns:
    
    the list value, never null.
  - toListValue
```
public ListValue toListValue()
```
    Convert an instance to a List PropertyValue.
    
    Returns:
    
    the list value, never null.
  - deepClone
```
protected PropertyValue deepClone()
```
    Creates a deep clone of this intance.
    
    Returns:
    
    a clone, never null.
  - checkImmutable
```
protected final void checkImmutable()
```
    Throws:
    
    IllegalStateException - if the instance is immutable.
  - incrementVersion
```
protected final int incrementVersion()
```
    Called to mark a change on this instance.
    
    Returns:
    
    the new version.
  - setVersion
```
protected final void setVersion(int version)
```
    Sets the new version, used iternally when cloning.
    
    Parameters:
    
    version - the new version.
  - setKey
```
public PropertyValue setKey(String key)
```
    Changes the entry's key, mapping also corresponding context entries.
    
    Parameters:
    
    key - the new key, not null.
    
    Returns:
    
    the builder for chaining.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    isImmutable()
  - setParent
```
protected PropertyValue setParent(PropertyValue parent)
```
    Sets the new parent, used iternally when converting between value types.
    
    Parameters:
    
    parent - the parent value.
    
    Returns:
    
    the simple value, never null.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PropertyValue

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Constructor Detail

PropertyValue

PropertyValue

Method Detail

createObject

createList

createValue

createList

createObject

mapProperties

mapProperties

mapProperties

isImmutable

immutable

mutable

getValueType

getKey

getValue

getSource

setValue

getQualifiedKey

getParent

getVersion

isRoot

isLeaf

getMeta

getMetaEntry

getMeta

getSize

iterator

setMeta

setMeta

removeMeta

toMap

toLocalMap

toString

toObjectValue

toListValue

deepClone

checkImmutable

incrementVersion

setVersion

setKey

setParent

equals

hashCode