OpenJDK 1.23 · javax.management.openmbean.CompositeData

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this `CompositeData` contains the key. containsKey(String the key to be tested. key) Returns `true` if and only if this `CompositeData` instance contains an item whose name is `key`.
public boolean	Returns: true if this `CompositeData` contains the value. containsValue(Object the value to be tested. value) Returns `true` if and only if this `CompositeData` instance contains an item whose value is `value`.
public boolean	Returns: `true` if the specified object is equal to this `CompositeData` instance. equals(Object the object to be compared for equality with this `CompositeData` instance. obj) Compares the specified `obj` parameter with this `CompositeData` instance for equality.
public Object	Returns: the value associated with this key. get(String the name of the item. key) Returns the value of the item whose name is `key`.
public Object[]	Returns: the values corresponding to the keys. getAll(String[] the names of the items. keys) Returns an array of the values of the items whose names are specified by `keys`, in the same order as `keys`.
public CompositeType	Returns: the type of this CompositeData. getCompositeType() Returns the composite type of this composite data instance.
public int	Returns: the hash code value for this `CompositeData` instance hashCode() Returns the hash code value for this `CompositeData` instance.
public String	Returns: a string representation of this `CompositeData` instance toString() Returns a string representation of this `CompositeData` instance.
public Collection<?>	Returns: the values. values() Returns an unmodifiable Collection view of the item values contained in this `CompositeData` instance.

Method Detail

containsKey back to summary

containsKey	back to summary
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. Parameters key:String the key to be tested. Returns:boolean true if this `CompositeData` contains the key.

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.

Parameters

key:String: the key to be tested.

Returns:boolean

true if this CompositeData contains the key.

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Returns `true` if and only if this `CompositeData` instance contains an item whose value is `value`. Parameters value:Object the value to be tested. Returns:boolean true if this `CompositeData` contains the value.

public boolean containsValue(Object value)

Returns true if and only if this CompositeData instance contains an item whose value is value.

Parameters

value:Object: the value to be tested.

Returns:boolean

true if this CompositeData contains the value.

equals back to summary

equals	back to summary
public boolean equals(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: `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 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 `equals` method of the `java.util.Collection` interface. Parameters obj:Object the object to be compared for equality with this `CompositeData` instance. Returns:boolean `true` if the specified object is equal to this `CompositeData` instance.

public boolean equals(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:

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 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 equals method of the java.util.Collection interface.

Parameters

obj:Object: the object to be compared for equality with this CompositeData instance.

Returns:boolean

true if the specified object is equal to this CompositeData instance.

get back to summary

get	back to summary
public Object get(String key) Returns the value of the item whose name is `key`. Parameters key:String the name of the item. Returns:Object the value associated with this key. Exceptions IllegalArgumentException: if `key` is a null or empty String. InvalidKeyException: if `key` is not an existing item name for this `CompositeData` instance.

public Object get(String key)

Returns the value of the item whose name is key.

Parameters

key:String: the name of the item.

Returns:Object

the value associated with this key.

Exceptions

IllegalArgumentException:: if key is a null or empty String.
InvalidKeyException:: if key is not an existing item name for this CompositeData instance.

getAll back to summary

getAll	back to summary
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:String[] the names of the items. Returns:Object[] the values corresponding to the keys. Exceptions IllegalArgumentException: if an element in `keys` is a null or empty String. InvalidKeyException: if an element in `keys` is not an existing item name for this `CompositeData` instance.

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:String[]: the names of the items.

Returns:Object[]

the values corresponding to the keys.

Exceptions

IllegalArgumentException:: if an element in keys is a null or empty String.
InvalidKeyException:: if an element in keys is not an existing item name for this CompositeData instance.

getCompositeType	back to summary
public CompositeType getCompositeType() Returns the composite type of this composite data instance. Returns:CompositeType the type of this CompositeData.

getCompositeType

back to summary

public CompositeType getCompositeType()

Returns the composite type of this composite data instance.

Returns:CompositeType: the type of this CompositeData.

hashCode back to summary

hashCode	back to summary
public 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()`. 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. Returns:int the hash code value for this `CompositeData` instance

public 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().

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.

Returns:int: the hash code value for this CompositeData instance

toString back to summary

toString	back to summary
public 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). Returns:String a string representation of this `CompositeData` instance

public 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).

Returns:String: a string representation of this CompositeData instance

values back to summary

values	back to summary
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. Returns:Collection<?> the 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.

Returns:Collection<?>: the values.

public Interface CompositeData

Method Summary

Method Detail