javax.management.openmbean
Interface CompositeData

All Known Implementing Classes:
CompositeDataSupport sample code for javax.management.openmbean.CompositeDataSupport definition code for javax.management.openmbean.CompositeDataSupport

public interface CompositeData

The CompositeData interface specifies the behavior of a specific type of complex open data objects which represent composite data structures.

Since:
1.5

Method Summary
 boolean containsKey sample code for javax.management.openmbean.CompositeData.containsKey(java.lang.String) definition code for javax.management.openmbean.CompositeData.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.CompositeData.containsValue(java.lang.Object) definition code for javax.management.openmbean.CompositeData.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.CompositeData.equals(java.lang.Object) definition code for javax.management.openmbean.CompositeData.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 CompositeData instance for equality.
 Object sample code for java.lang.Object definition code for java.lang.Object get sample code for javax.management.openmbean.CompositeData.get(java.lang.String) definition code for javax.management.openmbean.CompositeData.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.CompositeData.getAll(java.lang.String[]) definition code for javax.management.openmbean.CompositeData.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.CompositeData.getCompositeType() definition code for javax.management.openmbean.CompositeData.getCompositeType() ()
          Returns the composite type of this composite data instance.
 int hashCode sample code for javax.management.openmbean.CompositeData.hashCode() definition code for javax.management.openmbean.CompositeData.hashCode() ()
          Returns the hash code value for this CompositeData instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.CompositeData.toString() definition code for javax.management.openmbean.CompositeData.toString() ()
          Returns a string representation of this CompositeData instance.
 Collection sample code for java.util.Collection definition code for java.util.Collection values sample code for javax.management.openmbean.CompositeData.values() definition code for javax.management.openmbean.CompositeData.values() ()
          Returns an unmodifiable Collection view of the item values contained in this CompositeData instance.
 

Method Detail

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

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.

Returns:
the type of this CompositeData.

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

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.

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.CompositeData.getAll(java.lang.String[]) definition code for javax.management.openmbean.CompositeData.getAll(java.lang.String[])

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.

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.CompositeData.containsKey(java.lang.String) definition code for javax.management.openmbean.CompositeData.containsKey(java.lang.String)

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.

Parameters:
key - the key to be tested.
Returns:
true if this CompositeData contains the key.

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

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.

Parameters:
value - the value to be tested.
Returns:
true if this CompositeData contains the value.

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

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.

Returns:
the values.

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

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

This ensures that this equals method works properly for obj parameters which are different implementations of the CompositeData interface.
 

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 CompositeData instance;
Returns:
true if the specified object is equal to this CompositeData 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.CompositeData.hashCode() definition code for javax.management.openmbean.CompositeData.hashCode()

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

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 CompositeData 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.CompositeData.toString() definition code for javax.management.openmbean.CompositeData.toString()

String sample code for java.lang.String definition code for java.lang.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).

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 CompositeData instance