javax.management.openmbean
Class CompositeDataSupport

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.management.openmbean.CompositeDataSupport
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData

public class CompositeDataSupport
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

The CompositeDataSupport class is the open data class which implements the CompositeData interface.

Since:
1.5
See Also:
Serialized Form

Constructor Summary
CompositeDataSupport sample code for javax.management.openmbean.CompositeDataSupport.CompositeDataSupport(javax.management.openmbean.CompositeType, java.util.Map) definition code for javax.management.openmbean.CompositeDataSupport.CompositeDataSupport(javax.management.openmbean.CompositeType, java.util.Map) (CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType  compositeType, Map sample code for java.util.Map definition code for java.util.Map  items)
           Constructs a CompositeDataSupport instance with the specified compositeType, whose item names and corresponding values are given by the mappings in the map items.
CompositeDataSupport sample code for javax.management.openmbean.CompositeDataSupport.CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[]) definition code for javax.management.openmbean.CompositeDataSupport.CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[]) (CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType  compositeType, String sample code for java.lang.String definition code for java.lang.String [] itemNames, Object sample code for java.lang.Object definition code for 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 sample code for javax.management.openmbean.CompositeDataSupport.containsKey(java.lang.String) definition code for javax.management.openmbean.CompositeDataSupport.containsKey(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  key)
          Returns true if and only if this CompositeData instance contains an item whose name is key.
 boolean containsValue sample code for javax.management.openmbean.CompositeDataSupport.containsValue(java.lang.Object) definition code for javax.management.openmbean.CompositeDataSupport.containsValue(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  value)
          Returns true if and only if this CompositeData instance contains an item whose value is value.
 boolean equals sample code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object) definition code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares the specified obj parameter with this CompositeDataSupport instance for equality.
 Object sample code for java.lang.Object definition code for java.lang.Object get sample code for javax.management.openmbean.CompositeDataSupport.get(java.lang.String) definition code for javax.management.openmbean.CompositeDataSupport.get(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  key)
          Returns the value of the item whose name is key.
 Object sample code for java.lang.Object definition code for java.lang.Object [] getAll sample code for javax.management.openmbean.CompositeDataSupport.getAll(java.lang.String[]) definition code for javax.management.openmbean.CompositeDataSupport.getAll(java.lang.String[]) (String sample code for java.lang.String definition code for 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.
 CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType getCompositeType sample code for javax.management.openmbean.CompositeDataSupport.getCompositeType() definition code for javax.management.openmbean.CompositeDataSupport.getCompositeType() ()
          Returns the composite type of this composite data instance.
 int hashCode sample code for javax.management.openmbean.CompositeDataSupport.hashCode() definition code for javax.management.openmbean.CompositeDataSupport.hashCode() ()
          Returns the hash code value for this CompositeDataSupport instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.CompositeDataSupport.toString() definition code for javax.management.openmbean.CompositeDataSupport.toString() ()
          Returns a string representation of this CompositeDataSupport instance.
 Collection sample code for java.util.Collection definition code for java.util.Collection values sample code for javax.management.openmbean.CompositeDataSupport.values() definition code for javax.management.openmbean.CompositeDataSupport.values() ()
          Returns an unmodifiable Collection view of the item values contained in this CompositeData instance.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CompositeDataSupport sample code for javax.management.openmbean.CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[]) definition code for javax.management.openmbean.CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[])

public CompositeDataSupport(CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType  compositeType,
                            String sample code for java.lang.String definition code for java.lang.String [] itemNames,
                            Object sample code for java.lang.Object definition code for java.lang.Object [] itemValues)
                     throws OpenDataException sample code for javax.management.openmbean.OpenDataException definition code for javax.management.openmbean.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 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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - 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 sample code for javax.management.openmbean.OpenDataException definition code for javax.management.openmbean.OpenDataException - 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 sample code for javax.management.openmbean.CompositeDataSupport(javax.management.openmbean.CompositeType, java.util.Map) definition code for javax.management.openmbean.CompositeDataSupport(javax.management.openmbean.CompositeType, java.util.Map)

public CompositeDataSupport(CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType  compositeType,
                            Map sample code for java.util.Map definition code for java.util.Map  items)
                     throws OpenDataException sample code for javax.management.openmbean.OpenDataException definition code for javax.management.openmbean.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 in compositeType; must not be null or empty.

Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - 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 sample code for javax.management.openmbean.OpenDataException definition code for javax.management.openmbean.OpenDataException - 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.

ArrayStoreException sample code for java.lang.ArrayStoreException definition code for java.lang.ArrayStoreException - one or more keys in items is not of the class java.lang.String.

Method Detail

getCompositeType sample code for javax.management.openmbean.CompositeDataSupport.getCompositeType() definition code for javax.management.openmbean.CompositeDataSupport.getCompositeType()

public CompositeType sample code for javax.management.openmbean.CompositeType definition code for javax.management.openmbean.CompositeType  getCompositeType()
Returns the composite type of this composite data instance.

Specified by:
getCompositeType sample code for javax.management.openmbean.CompositeData.getCompositeType() definition code for javax.management.openmbean.CompositeData.getCompositeType() in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Returns:
the type of this CompositeData.

get sample code for javax.management.openmbean.CompositeDataSupport.get(java.lang.String) definition code for javax.management.openmbean.CompositeDataSupport.get(java.lang.String)

public Object sample code for java.lang.Object definition code for java.lang.Object  get(String sample code for java.lang.String definition code for java.lang.String  key)
Returns the value of the item whose name is key.

Specified by:
get sample code for javax.management.openmbean.CompositeData.get(java.lang.String) definition code for javax.management.openmbean.CompositeData.get(java.lang.String) in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Parameters:
key - the name of the item.
Returns:
the value associated with this key.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if key is a null or empty String.
InvalidKeyException sample code for javax.management.openmbean.InvalidKeyException definition code for javax.management.openmbean.InvalidKeyException - if key is not an existing item name for this CompositeData instance.

getAll sample code for javax.management.openmbean.CompositeDataSupport.getAll(java.lang.String[]) definition code for javax.management.openmbean.CompositeDataSupport.getAll(java.lang.String[])

public Object sample code for java.lang.Object definition code for java.lang.Object [] getAll(String sample code for java.lang.String definition code for 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.

Specified by:
getAll sample code for javax.management.openmbean.CompositeData.getAll(java.lang.String[]) definition code for javax.management.openmbean.CompositeData.getAll(java.lang.String[]) in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Parameters:
keys - the names of the items.
Returns:
the values corresponding to the keys.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if an element in keys is a null or empty String.
InvalidKeyException sample code for javax.management.openmbean.InvalidKeyException definition code for javax.management.openmbean.InvalidKeyException - if an element in keys is not an existing item name for this CompositeData instance.

containsKey sample code for javax.management.openmbean.CompositeDataSupport.containsKey(java.lang.String) definition code for javax.management.openmbean.CompositeDataSupport.containsKey(java.lang.String)

public boolean containsKey(String sample code for java.lang.String definition code for 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 sample code for javax.management.openmbean.CompositeData.containsKey(java.lang.String) definition code for javax.management.openmbean.CompositeData.containsKey(java.lang.String) in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Parameters:
key - the key to be tested.
Returns:
true if this CompositeData contains the key.

containsValue sample code for javax.management.openmbean.CompositeDataSupport.containsValue(java.lang.Object) definition code for javax.management.openmbean.CompositeDataSupport.containsValue(java.lang.Object)

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

Specified by:
containsValue sample code for javax.management.openmbean.CompositeData.containsValue(java.lang.Object) definition code for javax.management.openmbean.CompositeData.containsValue(java.lang.Object) in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Parameters:
value - the value to be tested.
Returns:
true if this CompositeData contains the value.

values sample code for javax.management.openmbean.CompositeDataSupport.values() definition code for javax.management.openmbean.CompositeDataSupport.values()

public Collection sample code for java.util.Collection definition code for 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 sample code for javax.management.openmbean.CompositeData.values() definition code for javax.management.openmbean.CompositeData.values() in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Returns:
the values.

equals sample code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object) definition code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.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:

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 sample code for java.util.Collection.equals(java.lang.Object) definition code for java.util.Collection.equals(java.lang.Object) method of the java.util.Collection interface.
 

Specified by:
equals sample code for javax.management.openmbean.CompositeData.equals(java.lang.Object) definition code for javax.management.openmbean.CompositeData.equals(java.lang.Object) in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the object to be compared for equality with this CompositeDataSupport instance;
Returns:
true if the specified object is equal to this CompositeDataSupport instance.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.openmbean.CompositeDataSupport.hashCode() definition code for javax.management.openmbean.CompositeDataSupport.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() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() .

However, note that another instance of a class implementing the CompositeData interface may be equal to this CompositeDataSupport instance as defined by equals(java.lang.Object) sample code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object) definition code for javax.management.openmbean.CompositeDataSupport.equals(java.lang.Object) , but may have a different hash code if it is calculated differently.

Specified by:
hashCode sample code for javax.management.openmbean.CompositeData.hashCode() definition code for javax.management.openmbean.CompositeData.hashCode() in interface CompositeData sample code for javax.management.openmbean.CompositeData definition code for javax.management.openmbean.CompositeData
Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hash code value for this CompositeDataSupport instance
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.management.openmbean.CompositeDataSupport.toString() definition code for javax.management.openmbean.CompositeDataSupport.toString()

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