Package org.apache.tamaya.spi

Class ListValue

java.lang.Object

org.apache.tamaya.spi.PropertyValue

org.apache.tamaya.spi.ListValue

All Implemented Interfaces:

Serializable, Iterable<PropertyValue>

public final class ListValue
extends 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/interfaces inherited from class org.apache.tamaya.spi.PropertyValue

PropertyValue.ValueType

Method Summary

Modifier and Type	Method	Description
ListValue	addList()	Adds an anonymous array.
ObjectValue	addObject()	Adds an anonymous child createObject to the array.
ListValue	addPropertyValue(PropertyValue value)	Adds a createValue to the array.
ListValue	addValue(String value)	Adds an anonymous text value to the array.
ListValue	addValues(String... values)	Adds text values to the array.
protected ListValue	deepClone()	Creates a deep clone of this intance.
boolean	equals(Object o)
static ListValue	from(Collection<PropertyValue> values)	Merges multiple values into one single node.
int	getIndex(PropertyValue member)	Get the index of the given member value.
List<ListValue>	getLists()	Get all array elements of type ListValue.
List<ListValue>	getLists(String name)	Get the array elements, filtered by the given name.
List<ObjectValue>	getObjects(String name)	Get the array elements, filtered by the given predicate.
PropertyValue	getPropertyValue(int n)	Get the n-th element of the children.
List<PropertyValue>	getPropertyValues(String name)	Get the text elements, filtered by the given name.
int	getSize()	Get the createValue's number of elements.
String	getValue()	Get the node's createValue.
String	getValue(int index)	Get a String value with the given key, if possible.
PropertyValue.ValueType	getValueType()	Get the item's current createValue type.
int	hashCode()
Iterator<PropertyValue>	iterator()
ListValue	mutable()	Clones this instance and all it's children, marking as mutable value.
PropertyValue	setValue(String value)	Sets the createValue.
ListValue	toListValue()	Convert an instance to a List PropertyValue.
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, toLocalMap, toMap

Method Detail

getValueType

public PropertyValue.ValueType getValueType()

Get the item's current createValue type.

Overrides:

getValueType in class PropertyValue

Returns:

the createValue type, never null.

getIndex

public int getIndex(PropertyValue member)

Get the index of the given member value.

Parameters:

member - the member, not null.

Returns:

the index, or -1.

getSize

public int getSize()

Get the createValue's number of elements.

Overrides:

getSize in class PropertyValue

Returns:

the getNumChilds of this multi createValue.

iterator

public Iterator<PropertyValue> iterator()

Specified by:

iterator in interface Iterable<PropertyValue>

Overrides:

iterator in class PropertyValue

addPropertyValue

public ListValue addPropertyValue(PropertyValue value)

Adds a createValue to the array.

Parameters:

value - the createValue, not null

Returns:

this instance, for chaining.

Throws:

IllegalStateException - if the instance is immutable.

See Also:

PropertyValue.isImmutable()

addValue

public ListValue addValue(String value)

Adds an anonymous text value to the array.

Parameters:

value - the child's value, not null.

Returns:

the created value, not null.

Throws:

IllegalStateException - if the instance is immutable.

See Also:

PropertyValue.isImmutable()

addValues

public ListValue addValues(String... values)

Adds text values to the array.

Parameters:

values - the child's values, not null.

Returns:

the created values, not null.

Throws:

IllegalStateException - if the instance is immutable.

See Also:

PropertyValue.isImmutable()

addObject

public ObjectValue addObject()

Adds an anonymous child createObject to the array.

Returns:

the created createObject, not null.

Throws:

IllegalStateException - if the instance is immutable.

See Also:

PropertyValue.isImmutable()

addList

public ListValue addList()

Adds an anonymous array.

Returns:

this instance, for chaining.

Throws:

IllegalStateException - if the instance is immutable.

See Also:

PropertyValue.isImmutable()

getValue

public String getValue(int index)

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:

index - the target index.

Returns:

the value found, or null.

getPropertyValue

public PropertyValue getPropertyValue(int n)

Get the n-th element of the children.

Parameters:

n - the index.

Returns:

the element found

Throws:

NoSuchElementException - if no such element exists.

getObjects

public List<ObjectValue> getObjects(String name)

Get the array elements, filtered by the given predicate.

Parameters:

name - the name of the objects, null selects all.

Returns:

this values matching, never null.

getLists

public List<ListValue> getLists(String name)

Get the array elements, filtered by the given name.

Parameters:

name - the name of the objects, null selects all.

Returns:

this values matching, never null.

getLists

public List<ListValue> getLists()

Get all array elements of type ListValue.

Returns:

this values matching, never null.

getPropertyValues

public List<PropertyValue> getPropertyValues(String name)

Get the text elements, filtered by the given name.

Parameters:

name - the name of the objects, null selects all.

Returns:

this values matching, never null.

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.

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()

mutable

public ListValue 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 ListValue 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 ListValue 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.