ObjectValue (Apache Tamaya Core API 0.4-incubating API)

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

All Implemented Interfaces:

Serializable, Iterable<PropertyValue>
```
public final class ObjectValue
extends PropertyValue
```
Class modelling the result of a request for a property value. A property value is basically identified by its key. There might be reasons, where one want to further analyze, which PropertySources provided a value and which not, so it is possible to createObject a PropertyValue with a null value. 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/interfaces inherited from class org.apache.tamaya.spi.PropertyValue
  PropertyValue.ValueType

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ListValue`	`addList(String key)`	Sets the given list value.
`ObjectValue`	`addObject(String key)`	Sets the given object vaöue.
`protected ObjectValue`	`deepClone()`	Creates a deep clone of this intance.
`boolean`	`equals(Object o)`
`static ObjectValue`	`from(Collection<PropertyValue> values)`	Merges multiple values into one single node.
`Set<String>`	`getKeys()`	Access the current present field names/keys.
`<T extends PropertyValue> T`	`getOrSetValue(String name, Supplier<T> valueSupplier)`	Get a single child getValue with the given name, creates it if not existing.
`PropertyValue`	`getPropertyValue(String name)`	Get a single child getValue by name.
`int`	`getSize()`	Get the value's number of elements.
`String`	`getValue()`	Get the node's createValue.
`String`	`getValue(String key)`	Get a String value with the given key, if possible.
`Collection<PropertyValue>`	`getValues()`	Get the fields of this instance.
`PropertyValue.ValueType`	`getValueType()`	Get the item's current value type.
`int`	`hashCode()`
`Iterator<PropertyValue>`	`iterator()`
`ObjectValue`	`mutable()`	Clones this instance and all it's children, marking as mutable value.
`protected ObjectValue`	`setPropertyValue(PropertyValue value)`	Adds another existing node, hereby setting the corresponding parent node.
`PropertyValue`	`setValue(String value)`	Sets the createValue.
`ObjectValue`	`setValue(String k, String v)`	Sets the given key, value pair.
`ObjectValue`	`setValues(Map<String,String> config)`	Applies a mapProperties of `Map<String,String>` to this instance as values.
`ObjectValue`	`setValues(Map<String,String> config, String source, boolean overwriteExisting)`	Applies a mapProperties of `Map<String,String>` to this instance as values.
`PropertyValue`	`setValueWithCompositeKey(String key, String value)`	Adds a new child getValue, where the getValue is given in '.'
`Collection<PropertyValue>`	`setValueWithCompositeKey(Map<String,String> values)`	Adds multiple values, where the keys are given in '.'
`ListValue`	`toListValue()`	Convert an instance to a List PropertyValue.
`Map<String,String>`	`toLocalMap()`	Convert the value tree to a local property map.
`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

Methods inherited from class org.apache.tamaya.spi.PropertyValue
checkImmutable, createList, createList, createObject, createObject, createValue, getKey, getMeta, getMeta, getMetaEntry, getParent, getQualifiedKey, getSource, getVersion, immutable, incrementVersion, isImmutable, isLeaf, isRoot, mapProperties, mapProperties, mapProperties, removeMeta, setKey, setMeta, setMeta, setParent, setVersion

- Method Detail
  - getValueType
```
public PropertyValue.ValueType getValueType()
```
    Get the item's current value type.
    
    Overrides:
    
    getValueType in class PropertyValue
    
    Returns:
    
    the value type, never null.
  - getValues
```
public Collection<PropertyValue> getValues()
```
    Get the fields of this instance.
    
    Returns:
    
    the current fields, never null.
  - getKeys
```
public Set<String> getKeys()
```
    Access the current present field names/keys.
    
    Returns:
    
    the keys present, never null.
  - getPropertyValue
```
public PropertyValue getPropertyValue(String name)
```
    Get a single child getValue by name.
    
    Parameters:
    
    name - the child's name, not null.
    
    Returns:
    
    the child found, or null.
    
    Throws:
    
    IllegalArgumentException - if multiple getPropertyValues with the given name are existing (ambigous).
  - getValue
```
public String getValue()
```
    Get the node's createValue.
    
    Overrides:
    
    getValue in class PropertyValue
    
    Returns:
    
    the createValue, or null.
  - setValue
```
public PropertyValue setValue(String value)
```
    Description copied from class: PropertyValue
    
    Sets the createValue.
    
    Overrides:
    
    setValue in class PropertyValue
    
    Parameters:
    
    value - the createValue
    
    Returns:
    
    this value for chaining.
    
    See Also:
    
    PropertyValue.isImmutable()
  - getValue
```
public String getValue(String key)
```
    Get a String value with the given key, if possible. If a node is present, but no value is setPropertyValue, then the node's toString() method is used as a result.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    the value found, or null.
  - getOrSetValue
```
public <T extends PropertyValue> T getOrSetValue(String name,
                                                 Supplier<T> valueSupplier)
```
    Get a single child getValue with the given name, creates it if not existing.
    
    Type Parameters:
    
    T - the target type.
    
    Parameters:
    
    name - the child's name, not null.
    
    valueSupplier - the supplier to create a new instance, if no value is present, not null.
    
    Returns:
    
    the child found or created, never null.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    PropertyValue.isImmutable()
  - getSize
```
public int getSize()
```
    Get the value's number of elements.
    
    Overrides:
    
    getSize in class PropertyValue
    
    Returns:
    
    the getNumChilds of this multi value.
  - setValues
```
public ObjectValue setValues(Map<String,String> config)
```
    Applies a mapProperties of Map<String,String> to this instance as values.
    
    Parameters:
    
    config - the String based mapProperties, not null.
    
    Returns:
    
    the corresponding createValue based mapProperties.
  - setValues
```
public ObjectValue setValues(Map<String,String> config,
                             String source,
                             boolean overwriteExisting)
```
    Applies a mapProperties of Map<String,String> to this instance as values.
    
    Parameters:
    
    config - the String based mapProperties, not null.
    
    source - the source name, optional.
    
    overwriteExisting - if true, existing values will be overridden.
    
    Returns:
    
    the corresponding createValue based mapProperties.
  - toObjectValue
```
public ObjectValue toObjectValue()
```
    Description copied from class: PropertyValue
    
    Convert an instance to a Object PropertyValue.
    
    Overrides:
    
    toObjectValue in class PropertyValue
    
    Returns:
    
    the list value, never null.
  - toListValue
```
public ListValue toListValue()
```
    Description copied from class: PropertyValue
    
    Convert an instance to a List PropertyValue.
    
    Overrides:
    
    toListValue in class PropertyValue
    
    Returns:
    
    the list value, never null.
  - iterator
```
public Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface Iterable<PropertyValue>
    
    Overrides:
    
    iterator in class PropertyValue
  - setPropertyValue
```
protected ObjectValue setPropertyValue(PropertyValue value)
```
    Adds another existing node, hereby setting the corresponding parent node.
    
    Parameters:
    
    value - the value, not null
    
    Returns:
    
    the value added, not null.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    PropertyValue.isImmutable()
  - setValue
```
public ObjectValue setValue(String k,
                            String v)
```
    Sets the given key, value pair.
    
    Parameters:
    
    k - the key, not null.
    
    v - the value, not null.
    
    Returns:
    
    the value added, not null.
  - addList
```
public ListValue addList(String key)
```
    Sets the given list value.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    the value added, not null.
  - addObject
```
public ObjectValue addObject(String key)
```
    Sets the given object vaöue.
    
    Parameters:
    
    key - the key, not null.
    
    Returns:
    
    the value added, not null.
  - setValueWithCompositeKey
```
public PropertyValue setValueWithCompositeKey(String key,
                                              String value)
```
    Adds a new child getValue, where the getValue is given in '.'-separated property notation, e.g. a.b.c.
    
    Parameters:
    
    key - the property key, e.g. a.b.c
    
    value - the property value
    
    Returns:
    
    the new leaf-getValue created.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    PropertyValue.isImmutable()
  - setValueWithCompositeKey
```
public Collection<PropertyValue> setValueWithCompositeKey(Map<String,String> values)
```
    Adds multiple values, where the keys are given in '.'-separated property notation, e.g. a.b.c.
    
    Parameters:
    
    values - the values, not null.
    
    Returns:
    
    the value instances created.
    
    Throws:
    
    IllegalStateException - if the instance is immutable.
    
    See Also:
    
    PropertyValue.isImmutable()
  - toMap
```
public Map<String,String> toMap()
```
    Convert the value tree to a property map.
    
    Overrides:
    
    toMap in class PropertyValue
    
    Returns:
    
    the corresponding property map, not null.
  - toLocalMap
```
public Map<String,String> toLocalMap()
```
    Convert the value tree to a local property map.
    
    Overrides:
    
    toLocalMap in class PropertyValue
    
    Returns:
    
    the corresponding local map, not null.
  - mutable
```
public ObjectValue mutable()
```
    Clones this instance and all it's children, marking as mutable value.
    
    Overrides:
    
    mutable in class PropertyValue
    
    Returns:
    
    the new value clone.
  - deepClone
```
protected ObjectValue deepClone()
```
    Description copied from class: PropertyValue
    
    Creates a deep clone of this intance.
    
    Overrides:
    
    deepClone in class PropertyValue
    
    Returns:
    
    a clone, never null.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class PropertyValue
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PropertyValue
  - toString
```
public String toString()
```
    Description copied from class: PropertyValue
    
    Create a String representation of the tree.
    
    Overrides:
    
    toString in class PropertyValue
    
    Returns:
    
    the corresponding String representation, not null.
  - from
```
public static ObjectValue from(Collection<PropertyValue> values)
```
    Merges multiple values into one single node.
    
    Parameters:
    
    values - the values to merge, not null.
    
    Returns:
    
    the merged instance, or null.

Class ObjectValue

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tamaya.spi.PropertyValue

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.tamaya.spi.PropertyValue

Method Detail

getValueType

getValues

getKeys

getPropertyValue

getValue

setValue

getValue

getOrSetValue

getSize

setValues

setValues

toObjectValue

toListValue

iterator

setPropertyValue

setValue

addList

addObject

setValueWithCompositeKey

setValueWithCompositeKey

toMap

toLocalMap

mutable

deepClone

equals

hashCode

toString

from