- java.lang.Object
-
- javax.management.openmbean.CompositeDataSupport
-
- All Implemented Interfaces:
- Serializable, CompositeData
public class CompositeDataSupport extends Object implements CompositeData, Serializable
The CompositeDataSupport class is the open data class which implements the CompositeData interface.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description CompositeDataSupport(CompositeType compositeType, Map<String,?> items)
Constructs a CompositeDataSupport instance with the specified compositeType, whose item names and corresponding values are given by the mappings in the map items.CompositeDataSupport(CompositeType compositeType, String[] itemNames, Object[] itemValues)
Constructs a CompositeDataSupport instance with the specified compositeType, whose item values are specified by itemValues[], in the same order as in itemNames[].
-
Method Summary
Methods Modifier and Type Method and Description boolean
containsKey(String key)
Returns true if and only if this CompositeData instance contains an item whose name is key.boolean
containsValue(Object value)
Returns true if and only if this CompositeData instance contains an item whose value is value.boolean
equals(Object obj)
Compares the specified obj parameter with thisCompositeDataSupport
instance for equality.Object
get(String key)
Returns the value of the item whose name is key.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.CompositeType
getCompositeType()
Returns the composite type of this composite data instance.int
hashCode()
Returns the hash code value for thisCompositeDataSupport
instance.String
toString()
Returns a string representation of thisCompositeDataSupport
instance.Collection<?>
values()
Returns an unmodifiable Collection view of the item values contained in this CompositeData instance.
-
-
-
Constructor Detail
-
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, String[] itemNames, Object[] itemValues) throws OpenDataException
Constructs a CompositeDataSupport instance with the specified compositeType, whose item values are specified by itemValues[], in the same order as in itemNames[]. As a CompositeType does not specify any order on its items, the itemNames[] parameter is used to specify the order in which the values are given in itemValues[]. The items contained in this CompositeDataSupport instance are internally stored in a TreeMap, 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
- itemNames must list, in any order, all the item names defined in compositeType; the order in which the names are listed, is used to match values in itemValues[]; must not be null or empty.itemValues
- the values of the items, listed in the same order as their respective names in itemNames; each item value can be null, but if it is non-null it must be a valid value for the open type defined in compositeType for the corresponding item; must be of the same size as itemNames; must not be null or empty.- Throws:
IllegalArgumentException
- compositeType is null, or itemNames[] or itemValues[] is null or empty, or one of the elements in itemNames[] is a null or empty string, or itemNames[] and itemValues[] are not of the same size.OpenDataException
- itemNames[] or itemValues[]'s size differs from the number of items defined in compositeType, or one of the elements in itemNames[] does not exist as an item name defined in compositeType, or one of the elements in itemValues[] is not a valid value for the corresponding item as defined in compositeType.
-
CompositeDataSupport
public CompositeDataSupport(CompositeType compositeType, Map<String,?> items) throws OpenDataException
Constructs a CompositeDataSupport instance with the specified compositeType, whose item names and corresponding values are given by the mappings in the map items. This constructor converts the keys to a string array and the values to an object array and calls CompositeDataSupport(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; items must contain all the item names defined in compositeType; must not be null or empty.- Throws:
IllegalArgumentException
- compositeType is null, or items is null or empty, or one of the keys in items is a null or empty string.OpenDataException
- items' size differs from the number of items defined in compositeType, or one of the keys in items does not exist as an item name defined in compositeType, or one of the values in items is not a valid value for the corresponding item as defined in compositeType.ArrayStoreException
- one or more keys in items is not of the class java.lang.String.
-
-
Method Detail
-
getCompositeType
public CompositeType getCompositeType()
Returns the composite type of this composite data instance.- Specified by:
getCompositeType
in interfaceCompositeData
- Returns:
- the type of this CompositeData.
-
get
public Object get(String key)
Returns the value of the item whose name is key.- Specified by:
get
in interfaceCompositeData
- Parameters:
key
- the name of the item.- Returns:
- the value associated with this key.
- Throws:
IllegalArgumentException
- if key is a null or empty String.InvalidKeyException
- if key is not an existing item name for this CompositeData instance.
-
getAll
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.- Specified by:
getAll
in interfaceCompositeData
- Parameters:
keys
- the names of the items.- Returns:
- the values corresponding to the keys.
- Throws:
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.
-
containsKey
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.- Specified by:
containsKey
in interfaceCompositeData
- Parameters:
key
- the key to be tested.- Returns:
- true if this CompositeData contains the key.
-
containsValue
public boolean containsValue(Object value)
Returns true if and only if this CompositeData instance contains an item whose value is value.- Specified by:
containsValue
in interfaceCompositeData
- Parameters:
value
- the value to be tested.- Returns:
- true if this CompositeData contains the value.
-
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.- Specified by:
values
in interfaceCompositeData
- Returns:
- the values.
-
equals
public boolean equals(Object obj)
Compares the specified obj parameter with thisCompositeDataSupport
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 ofArrays.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 theequals
method of the java.util.Collection interface.- Specified by:
equals
in interfaceCompositeData
- Overrides:
equals
in classObject
- Parameters:
obj
- the object to be compared for equality with thisCompositeDataSupport
instance.- Returns:
true
if the specified object is equal to thisCompositeDataSupport
instance.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns the hash code value for thisCompositeDataSupport
instance.The hash code of a
CompositeDataSupport
instance is the sum of the hash codes of all elements of information used inequals
comparisons (ie: its composite type and all the item values).This ensures that
t1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoCompositeDataSupport
instancest1
andt2
, 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
deepHashCode
method for arrays of object reference types or the appropriate overloading ofArrays.hashCode(e)
for arrays of primitive types.- Specified by:
hashCode
in interfaceCompositeData
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this
CompositeDataSupport
instance - See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
toString
public String toString()
Returns a string representation of thisCompositeDataSupport
instance.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:
toString
in interfaceCompositeData
- Overrides:
toString
in classObject
- Returns:
- a string representation of this
CompositeDataSupport
instance
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/11/2024 04:48:14 Cette version de la page est en cache (à la date du 22/11/2024 04:48:14) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 06/12/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/management/openmbean/CompositeDataSupport.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.