javax.management.openmbean
Class CompositeDataSupport

java.lang.Object
  |
  +--javax.management.openmbean.CompositeDataSupport
All Implemented Interfaces:
CompositeData, java.io.Serializable

public class CompositeDataSupport
extends java.lang.Object
implements CompositeData, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
CompositeDataSupport(javax.management.openmbean.CompositeType compositeType, java.util.Map items)
          Constructs a CompositeDataSupport instance with the specified compositeType, whose items names and corresponding values are given by the mappings in the map items.
CompositeDataSupport(javax.management.openmbean.CompositeType compositeType, java.lang.String[] itemNames, java.lang.Object[] itemValues)
          Constructs a CompositeDataSupport instance with the specified compositeType, whose item values are specified by itemValues[], in the same order as in itemNames[].
 
Method Summary
 boolean containsKey(java.lang.String key)
          Returns true if and only if this CompositeData instance contains an item whose name is key.
 boolean containsValue(java.lang.Object value)
          Returns true if and only if this CompositeData instance contains an item whose value is value
 boolean equals(java.lang.Object obj)
          tests that the Object obj is equal to this compositeData instance
 java.lang.Object get(java.lang.String key)
           
 java.lang.Object[] getAll(java.lang.String[] keys)
          Returns an array of the values of the items whose names are specified by keys, in the same order as keys this method simple calls get for each key
 javax.management.openmbean.CompositeType getCompositeType()
           
 int hashCode()
          Using the same information as in equals test to create the hashcode i.e) 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).
 java.lang.String toString()
          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).
 java.util.Collection values()
          Returns an unmodifiable Collection view of the item values contained in this CompositeData instance.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompositeDataSupport

public CompositeDataSupport(javax.management.openmbean.CompositeType compositeType,
                            java.lang.String[] itemNames,
                            java.lang.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 constrainsts 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 in compositeType; the order in which the names are listed, is used to match values in itemValues[]; must not be null or empty.
itemValues - - the values of the items, listed in the same order as their respective names in itemNames; each item value can be null, but if it is non-null it must be a valid value for the open type defined in compositeType for the corresponding item; must be of the same size as itemNames; must not be null or empty.
Throws:
java.lang.IllegalArgumentException - if compositeType is null, or itemNames[] or itemValues[] is null or empty, or one of the elements in itemNames[] is a null or empty string, or itemNames[] and itemValues[] are not of the same size.
OpenDataException - if itemNames[] or itemValues[]'s size differs from the number of items defined in compositeType, or one of the elements in itemNames[] does not exist as an item name defined in compositeType, or one of the elements in itemValues[] is not a valid value for the corresponding item as defined in compositeType

CompositeDataSupport

public CompositeDataSupport(javax.management.openmbean.CompositeType compositeType,
                            java.util.Map items)
                     throws OpenDataException
Constructs a CompositeDataSupport instance with the specified compositeType, whose items 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 in compositeType; must not be null or empty
Throws:
java.lang.IllegalArgumentException - - if compositeType is null, or items is null or empty, or one of the keys in items is a null or empty string, or one of the values in items is null
OpenDataException - - if items' size differs from the number of items defined in compositeType, or one of the keys in items does not exist as an item name defined in compositeType, or one of the values in items is not a valid value for the corresponding item as defined in compositeType.
java.lang.ArrayStoreException - - if any of the keys in items cannot be cast to a String
Method Detail

getCompositeType

public javax.management.openmbean.CompositeType getCompositeType()
Specified by:
getCompositeType in interface CompositeData
Returns:
the composite type of this composite data instance

get

public java.lang.Object get(java.lang.String key)
Specified by:
get in interface CompositeData
Parameters:
key - - the key for which to return the value
Returns:
- the value of the item whose name is key
Throws:
java.lang.IllegalArgumentException - if key is null or an empty String
InvalidKeyException - if key is not an existing item name for this CompositeData instance

getAll

public java.lang.Object[] getAll(java.lang.String[] keys)
Returns an array of the values of the items whose names are specified by keys, in the same order as keys this method simple calls get for each key

Specified by:
getAll in interface CompositeData
Returns:
the resulting array of values found
Throws:
java.lang.IllegalArgumentException - if an element in keys is null or an empty String
InvalidKeyException - if a key is not currently stored in this instances map

containsKey

public boolean containsKey(java.lang.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 interface CompositeData
Parameters:
key - the key for which to find a value
Returns:
true if value found false otherwise

containsValue

public boolean containsValue(java.lang.Object value)
Returns true if and only if this CompositeData instance contains an item whose value is value

Specified by:
containsValue in interface CompositeData
Parameters:
value - - the value to determine if present
Returns:
true if found false otherwise

values

public java.util.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 interface CompositeData
Returns:
unmodifiable collection of current values

equals

public boolean equals(java.lang.Object obj)
tests that the Object obj is equal to this compositeData instance

Specified by:
equals in interface CompositeData
Overrides:
equals in class java.lang.Object
Parameters:
obj - - the Object to test if is equals
Returns:
true if and only if
  • obj is an instanceof CompositeData as tested by instanceof CompositeData
  • all of the name/value pairs in the objects map are equal to the name/value pairs of this instance
  • if the compositeTypes are equal

hashCode

public int hashCode()
Using the same information as in equals test to create the hashcode i.e) 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).

Specified by:
hashCode in interface CompositeData
Overrides:
hashCode in class java.lang.Object
Returns:
the calculated HashCode for this Object

toString

public java.lang.String toString()
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 interface CompositeData
Overrides:
toString in class java.lang.Object
Returns:
a string representation of this CompositeDataSupport instance.