public interface CompositeData
The CompositeData
interface specifies the behavior of a specific type of complex open data objects which represent composite data structures.
CompositeType getCompositeType()
Returns the composite type of this composite data instance.
Object get(String key)
Returns the value of the item whose name is key
.
key
- the name of the item.IllegalArgumentException
- if key
is a null or empty String.InvalidKeyException
- if key
is not an existing item name for this CompositeData
instance.Object[] getAll(String[] keys)
Returns an array of the values of the items whose names are specified by keys
, in the same order as keys
.
keys
- the names of the items.IllegalArgumentException
- if an element in keys
is a null or empty String.InvalidKeyException
- if an element in keys
is not an existing item name for this CompositeData
instance.boolean containsKey(String key)
Returns true
if and only if this CompositeData
instance contains an item whose name is key
. If key
is a null or empty String, this method simply returns false.
key
- the key to be tested.CompositeData
contains the key.boolean containsValue(Object value)
Returns true
if and only if this CompositeData
instance contains an item whose value is value
.
value
- the value to be tested.CompositeData
contains the value.Collection<?> values()
Returns an unmodifiable Collection view of the item values contained in this CompositeData
instance. The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding item names.
boolean equals(Object obj)
Compares the specified obj parameter with this CompositeData
instance for equality.
Returns true
if and only if all of the following statements are true:
CompositeData
interface,deepEquals
method for arrays of object reference types or the appropriate overloading of Arrays.equals(e1,e2)
for arrays of primitive types This ensures that this equals
method works properly for obj parameters which are different implementations of the CompositeData
interface, with the restrictions mentioned in the equals
method of the java.util.Collection
interface.
equals
in class Object
obj
- the object to be compared for equality with this CompositeData
instance.true
if the specified object is equal to this CompositeData
instance.Object.hashCode()
, HashMap
int hashCode()
Returns the hash code value for this CompositeData
instance.
The hash code of a CompositeData
instance is the sum of the hash codes of all elements of information used in equals
comparisons (ie: its composite type and all the item values).
This ensures that t1.equals(t2)
implies that t1.hashCode()==t2.hashCode()
for any two CompositeData
instances t1
and t2
, as required by the general contract of the method Object.hashCode()
.
Each item value's hash code is added to the returned hash code. If an item value is an array, its hash code is obtained as if by calling the deepHashCode
method for arrays of object reference types or the appropriate overloading of Arrays.hashCode(e)
for arrays of primitive types.
hashCode
in class Object
CompositeData
instanceObject.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
String toString()
Returns a string representation of this CompositeData
instance.
The string representation consists of the name of the implementing class, the string representation of the composite type of this instance, and the string representation of the contents (ie list the itemName=itemValue mappings).
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.