FileDocCategorySizeDatePackage
CompositeData.javaAPI DocJava SE 6 API6070Tue Jun 10 00:26:16 BST 2008javax.management.openmbean

CompositeData

public interface CompositeData
The CompositeData interface specifies the behavior of a specific type of complex open data objects which represent composite data structures.
version
3.25 05/11/17
author
Sun Microsystems, Inc.
since
1.5
since.unbundled
JMX 1.1

Fields Summary
Constructors Summary
Methods Summary
public booleancontainsKey(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.

param
key the key to be tested.
return
true if this CompositeData contains the key.

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

param
value the value to be tested.
return
true if this CompositeData contains the value.

public booleanequals(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:

  • 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 {@link java.util.Arrays#deepEquals(Object[], Object[]) deepEquals} method for arrays of object reference types or the appropriate overloading of {@code 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 {@link java.util.Collection#equals(Object) equals} method of the java.util.Collection interface.

param
obj the object to be compared for equality with this CompositeData instance.
return
true if the specified object is equal to this CompositeData instance.

public java.lang.Objectget(java.lang.String key)
Returns the value of the item whose name is key.

param
key the name of the item.
return
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.

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.

param
keys the names of the items.
return
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.

public javax.management.openmbean.CompositeTypegetCompositeType()
Returns the composite type of this composite data instance.

return
the type of this CompositeData.

public inthashCode()
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 {@link 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 {@link java.util.Arrays#deepHashCode(Object[]) deepHashCode} method for arrays of object reference types or the appropriate overloading of {@code Arrays.hashCode(e)} for arrays of primitive types.

return
the hash code value for this CompositeData instance

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

return
a string representation of this CompositeData instance

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

return
the values.