Class CompositeDataSupport
- java.lang.Object
-
- javax.management.openmbean.CompositeDataSupport
- All Implemented Interfaces:
-
Serializable
,CompositeData
public class CompositeDataSupport extends Object implements CompositeData, Serializable
The CompositeDataSupport
class is the open data class which implements the CompositeData
interface.
- Since:
- 1.5
- See Also:
- Serialized Form
Constructor Summary
Constructor | Description |
---|---|
CompositeDataSupport(CompositeType compositeType,
String[] itemNames,
Object[] itemValues) | Constructs a |
CompositeDataSupport(CompositeType compositeType,
Map<String,?> items) | Constructs a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | containsKey(String key) | Returns |
boolean | containsValue(Object value) | Returns |
boolean | equals(Object obj) | Compares the specified obj parameter with this |
Object | get(String key) | Returns the value of the item whose name is |
Object[] | getAll(String[] keys) | Returns an array of the values of the items whose names are specified by |
CompositeType | getCompositeType() | Returns the composite type of this composite data instance. |
int | hashCode() | Returns the hash code value for this |
String | toString() | Returns a string representation of this |
Collection<?> | values() | Returns an unmodifiable Collection view of the item values contained in this |
Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Constructor Detail
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, String[] itemNames, Object[] itemValues) throws OpenDataException
Constructs a CompositeDataSupport
instance with the specified compositeType
, whose item values are specified by itemValues[]
, in the same order as in itemNames[]
. As a CompositeType
does not specify any order on its items, the itemNames[]
parameter is used to specify the order in which the values are given in itemValues[]
. The items contained in this CompositeDataSupport
instance are internally stored in a TreeMap
, thus sorted in ascending lexicographic order of their names, for faster retrieval of individual item values.
The constructor checks that all the constraints listed below for each parameter are satisfied, and throws the appropriate exception if they are not.
- Parameters:
-
compositeType
- the composite type of this composite data instance; must not be null. -
itemNames
-itemNames
must list, in any order, all the item names defined incompositeType
; the order in which the names are listed, is used to match values initemValues[]
; must not be null or empty. -
itemValues
- the values of the items, listed in the same order as their respective names initemNames
; each item value can be null, but if it is non-null it must be a valid value for the open type defined incompositeType
for the corresponding item; must be of the same size asitemNames
; must not be null or empty. - Throws:
-
IllegalArgumentException
-compositeType
is null, oritemNames[]
oritemValues[]
is null or empty, or one of the elements initemNames[]
is a null or empty string, oritemNames[]
anditemValues[]
are not of the same size. -
OpenDataException
-itemNames[]
oritemValues[]
's size differs from the number of items defined incompositeType
, or one of the elements initemNames[]
does not exist as an item name defined incompositeType
, or one of the elements initemValues[]
is not a valid value for the corresponding item as defined incompositeType
.
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, Map<String,?> items) throws OpenDataException
Constructs a CompositeDataSupport
instance with the specified compositeType
, whose item names and corresponding values are given by the mappings in the map items
. This constructor converts the keys to a string array and the values to an object array and calls CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[])
.
- Parameters:
-
compositeType
- the composite type of this composite data instance; must not be null. -
items
- the mappings of all the item names to their values;items
must contain all the item names defined incompositeType
; must not be null or empty. - Throws:
-
IllegalArgumentException
-compositeType
is null, oritems
is null or empty, or one of the keys initems
is a null or empty string. -
OpenDataException
-items
' size differs from the number of items defined incompositeType
, or one of the keys initems
does not exist as an item name defined incompositeType
, or one of the values initems
is not a valid value for the corresponding item as defined incompositeType
. -
ArrayStoreException
- one or more keys initems
is not of the classjava.lang.String
.
Method Detail
getCompositeType
public CompositeType getCompositeType()
Returns the composite type of this composite data instance.
- Specified by:
-
getCompositeType
in interfaceCompositeData
- Returns:
- the type of this CompositeData.
get
public Object get(String key)
Returns the value of the item whose name is key
.
- Specified by:
-
get
in interfaceCompositeData
- Parameters:
-
key
- the name of the item. - Returns:
- the value associated with this key.
- Throws:
-
IllegalArgumentException
- ifkey
is a null or empty String. -
InvalidKeyException
- ifkey
is not an existing item name for thisCompositeData
instance.
getAll
public 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
.
- Specified by:
-
getAll
in interfaceCompositeData
- Parameters:
-
keys
- the names of the items. - Returns:
- the values corresponding to the keys.
- Throws:
-
IllegalArgumentException
- if an element inkeys
is a null or empty String. -
InvalidKeyException
- if an element inkeys
is not an existing item name for thisCompositeData
instance.
containsKey
public 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.
- Specified by:
-
containsKey
in interfaceCompositeData
- Parameters:
-
key
- the key to be tested. - Returns:
- true if this
CompositeData
contains the key.
containsValue
public boolean containsValue(Object value)
Returns true
if and only if this CompositeData
instance contains an item whose value is value
.
- Specified by:
-
containsValue
in interfaceCompositeData
- Parameters:
-
value
- the value to be tested. - Returns:
- true if this
CompositeData
contains the value.
values
public 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.
- Specified by:
-
values
in interfaceCompositeData
- Returns:
- the values.
equals
public boolean equals(Object obj)
Compares the specified obj parameter with this CompositeDataSupport
instance for equality.
Returns true
if and only if all of the following statements are true:
- obj is non null,
-
obj also implements the
CompositeData
interface, - their composite types are equal
- their contents, i.e. (name, value) pairs are equal. If a value contained in the content is an array, the value comparison is done as if by calling the
deepEquals
method for arrays of object reference types or the appropriate overloading ofArrays.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.
- Specified by:
-
equals
in interfaceCompositeData
- Overrides:
-
equals
in classObject
- Parameters:
-
obj
- the object to be compared for equality with thisCompositeDataSupport
instance. - Returns:
-
true
if the specified object is equal to thisCompositeDataSupport
instance. - See Also:
-
Object.hashCode()
,HashMap
hashCode
public int hashCode()
Returns the hash code value for this CompositeDataSupport
instance.
The hash code of a CompositeDataSupport
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 CompositeDataSupport
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.
- Specified by:
-
hashCode
in interfaceCompositeData
- Overrides:
-
hashCode
in classObject
- Returns:
- the hash code value for this
CompositeDataSupport
instance - See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
toString
public String toString()
Returns a string representation of this CompositeDataSupport
instance.
The string representation consists of the name of this class (ie javax.management.openmbean.CompositeDataSupport
), the string representation of the composite type of this instance, and the string representation of the contents (ie list the itemName=itemValue mappings).
- Specified by:
-
toString
in interfaceCompositeData
- Overrides:
-
toString
in classObject
- Returns:
- a string representation of this
CompositeDataSupport
instance