- All Implemented Interfaces:
Serializable,CompositeData
CompositeDataSupport class is the open data class which
implements the CompositeData interface.- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCompositeDataSupport(CompositeType compositeType, String[] itemNames, Object[] itemValues) Constructs aCompositeDataSupportinstance with the specifiedcompositeType, whose item values are specified byitemValues[], in the same order as initemNames[].CompositeDataSupport(CompositeType compositeType, Map<String, ?> items) Constructs aCompositeDataSupportinstance with the specifiedcompositeType, whose item names and corresponding values are given by the mappings in the mapitems. -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsKey(String key) Returnstrueif and only if thisCompositeDatainstance contains an item whose name iskey.booleancontainsValue(Object value) Returnstrueif and only if thisCompositeDatainstance contains an item whose value isvalue.booleanCompares the specified obj parameter with thisCompositeDataSupportinstance for equality.Returns the value of the item whose name iskey.Object[]Returns an array of the values of the items whose names are specified bykeys, in the same order askeys.Returns the composite type of this composite data instance.inthashCode()Returns the hash code value for thisCompositeDataSupportinstance.toString()Returns a string representation of thisCompositeDataSupportinstance.Collection<?> values()Returns an unmodifiable Collection view of the item values contained in thisCompositeDatainstance.
-
Constructor Details
-
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, String[] itemNames, Object[] itemValues) throws OpenDataException Constructs a
CompositeDataSupportinstance with the specifiedcompositeType, whose item values are specified byitemValues[], in the same order as initemNames[]. As aCompositeTypedoes not specify any order on its items, theitemNames[]parameter is used to specify the order in which the values are given initemValues[]. The items contained in thisCompositeDataSupportinstance are internally stored in aTreeMap, 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-itemNamesmust list, in any order, all the item names defined incompositeType; the order in which the names are listed, is used to match values initemValues[]; must not be null or empty.itemValues- the values of the items, listed in the same order as their respective names initemNames; each item value can be null, but if it is non-null it must be a valid value for the open type defined incompositeTypefor the corresponding item; must be of the same size asitemNames; must not be null or empty.- Throws:
IllegalArgumentException-compositeTypeis null, oritemNames[]oritemValues[]is null or empty, or one of the elements initemNames[]is a null or empty string, oritemNames[]anditemValues[]are not of the same size.OpenDataException-itemNames[]oritemValues[]'s size differs from the number of items defined incompositeType, or one of the elements initemNames[]does not exist as an item name defined incompositeType, or one of the elements initemValues[]is not a valid value for the corresponding item as defined incompositeType.
-
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, Map<String, ?> items) throws OpenDataExceptionConstructs a
CompositeDataSupportinstance with the specifiedcompositeType, whose item names and corresponding values are given by the mappings in the mapitems. This constructor converts the keys to a string array and the values to an object array and callsCompositeDataSupport(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;itemsmust contain all the item names defined incompositeType; must not be null or empty.- Throws:
IllegalArgumentException-compositeTypeis null, oritemsis null or empty, or one of the keys initemsis a null or empty string.OpenDataException-items' size differs from the number of items defined incompositeType, or one of the keys initemsdoes not exist as an item name defined incompositeType, or one of the values initemsis not a valid value for the corresponding item as defined incompositeType.ArrayStoreException- one or more keys initemsis not of the classjava.lang.String.
-
-
Method Details
-
getCompositeType
Returns the composite type of this composite data instance.- Specified by:
getCompositeTypein interfaceCompositeData- Returns:
- the type of this CompositeData.
-
get
Returns the value of the item whose name iskey.- Specified by:
getin interfaceCompositeData- Parameters:
key- the name of the item.- Returns:
- the value associated with this key.
- Throws:
IllegalArgumentException- ifkeyis a null or empty String.InvalidKeyException- ifkeyis not an existing item name for thisCompositeDatainstance.
-
getAll
Returns an array of the values of the items whose names are specified bykeys, in the same order askeys.- Specified by:
getAllin interfaceCompositeData- Parameters:
keys- the names of the items.- Returns:
- the values corresponding to the keys.
- Throws:
IllegalArgumentException- if an element inkeysis a null or empty String.InvalidKeyException- if an element inkeysis not an existing item name for thisCompositeDatainstance.
-
containsKey
Returnstrueif and only if thisCompositeDatainstance contains an item whose name iskey. Ifkeyis a null or empty String, this method simply returns false.- Specified by:
containsKeyin interfaceCompositeData- Parameters:
key- the key to be tested.- Returns:
- true if this
CompositeDatacontains the key.
-
containsValue
Returnstrueif and only if thisCompositeDatainstance contains an item whose value isvalue.- Specified by:
containsValuein interfaceCompositeData- Parameters:
value- the value to be tested.- Returns:
- true if this
CompositeDatacontains the value.
-
values
Returns an unmodifiable Collection view of the item values contained in thisCompositeDatainstance. The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding item names.- Specified by:
valuesin interfaceCompositeData- Returns:
- the values.
-
equals
Compares the specified obj parameter with thisCompositeDataSupportinstance for equality.Returns
trueif and only if all of the following statements are true:- obj is non null,
- obj also implements the
CompositeDatainterface, - 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
deepEqualsmethod for arrays of object reference types or the appropriate overloading ofArrays.equals(e1,e2)for arrays of primitive types
This ensures that this
equalsmethod works properly for obj parameters which are different implementations of theCompositeDatainterface, with the restrictions mentioned in theequalsmethod of thejava.util.Collectioninterface.- Specified by:
equalsin interfaceCompositeData- Overrides:
equalsin classObject- Parameters:
obj- the object to be compared for equality with thisCompositeDataSupportinstance.- Returns:
trueif the specified object is equal to thisCompositeDataSupportinstance.- See Also:
-
hashCode
public int hashCode()Returns the hash code value for thisCompositeDataSupportinstance.The hash code of a
CompositeDataSupportinstance is the sum of the hash codes of all elements of information used inequalscomparisons (ie: its composite type and all the item values).This ensures that
t1.equals(t2)implies thatt1.hashCode()==t2.hashCode()for any twoCompositeDataSupportinstancest1andt2, as required by the general contract of the methodObject.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
deepHashCodemethod for arrays of object reference types or the appropriate overloading ofArrays.hashCode(e)for arrays of primitive types.- Specified by:
hashCodein interfaceCompositeData- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
CompositeDataSupportinstance - See Also:
-
toString
Returns a string representation of thisCompositeDataSupportinstance.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:
toStringin interfaceCompositeData- Overrides:
toStringin classObject- Returns:
- a string representation of this
CompositeDataSupportinstance
-