| |
|
| javax.management.openmbean.CompositeData
All known Subclasses: javax.management.openmbean.CompositeDataSupport,
| CompositeData | | public interface CompositeData (Code) | | 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 | |
| public boolean | containsKey(String key)
Returns true if and only if this CompositeData instance contains
an item whose name is key. | | public boolean | containsValue(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. | | public boolean | equals(Object obj)
Compares the specified obj parameter with this
CompositeData instance for equality. | | public Object | get(String key)
Returns the value of the item whose name is key.
Parameters:
key - the name of the item. | | 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.
Parameters:
keys - the names of the items. | | public CompositeType | getCompositeType()
Returns the composite type of this composite data instance. | | public int | hashCode()
Returns the hash code value for this CompositeData instance. | | public String | toString()
Returns a string representation of this CompositeData instance. | | 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. |
| containsKey | | public boolean containsKey(String key)(Code) | | 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. true if this CompositeData contains the key. |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if and only if this CompositeData instance contains an item
whose value is value.
Parameters:
value - the value to be tested. true if this CompositeData contains the value. |
| equals | | public boolean equals(Object obj)(Code) | | Compares the specified obj parameter with this
CompositeData 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
java.util.Arrays.deepEquals(Object[]Object[]) 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
java.util.Collection.equals(Object) equals
method of the java.util.Collection interface.
Parameters:
obj - the object to be compared for equality with thisCompositeData instance. true if the specified object is equal to thisCompositeData instance. |
| get | | public Object get(String key)(Code) | | Returns the value of the item whose name is key.
Parameters:
key - the name of the item. the value associated with this key.
throws:
IllegalArgumentException - if key is a null or empty String.
throws:
InvalidKeyException - if key is not an existing item name for this CompositeData instance. |
| getAll | | public Object[] getAll(String[] keys)(Code) | | 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. the values corresponding to the keys.
throws:
IllegalArgumentException - if an element in keys is a null or empty String.
throws:
InvalidKeyException - if an element in keys is not an existing item name for this CompositeData instance. |
| getCompositeType | | public CompositeType getCompositeType()(Code) | | Returns the composite type of this composite data instance.
the type of this CompositeData. |
| hashCode | | public int hashCode()(Code) | | 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 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
java.util.Arrays.deepHashCode(Object[]) deepHashCode method
for arrays of object reference types or the appropriate overloading
of
Arrays.hashCode(e) for arrays of primitive types.
the hash code value for this CompositeData instance |
| toString | | public String toString()(Code) | | 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).
a string representation of this CompositeData instance |
| values | | public Collection values()(Code) | | 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.
the values. |
|
|
|