Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.management.openmbean

Interface CompositeData

Known Implementing Classes:
CompositeDataSupport
public interface CompositeData
Provides an interface to a composite data structure, in order to aid interoperability. The composite data structure is represented by mapping field names to values.
Since:
1.5

Method Summary

boolean
containsKey(String key)
Returns true if this CompositeData instance contains the specified key.
boolean
containsValue(Object value)
Returns true if this CompositeData instance has a value equal to that supplied.
boolean
equals(Object obj)
Compares the specified object with this object for equality.
Object
get(String key)
Retrieves the value for the specified key.
Object[]
getAll(String[] keys)
Returns the appropriate value for each key in the given array, using the same ordering.
CompositeType
getCompositeType()
Returns the composite type which corresponds to this instance of CompositeData.
int
hashCode()
Returns the hash code of this instance.
String
toString()
Returns a textual representation of this instance.
Collection
values()
Returns a read-only collection of the values associated with this instance.

Method Details

containsKey

public boolean containsKey(String key)
Returns true if this CompositeData instance contains the specified key. This method always returns false for an input key equal to null or the empty string.
Parameters:
key - the key to find in the structure.
Returns:
true if the key exists.

containsValue

public boolean containsValue(Object value)
Returns true if this CompositeData instance has a value equal to that supplied.
Parameters:
value - the value to look for.
Returns:
true if the value exists.

equals

public boolean equals(Object obj)
Compares the specified object with this object for equality. The object is judged equivalent if it is non-null, and also an instance of CompositeData with the same name-value mappings and types. The two compared instances may be equivalent even if they represent different implementations of CompositeData.
Overrides:
equals in interface Object
Parameters:
obj - the object to compare for equality.
Returns:
true if obj is equal to this.

get

public Object get(String key)
Retrieves the value for the specified key.
Parameters:
key - the key whose value should be returned.
Returns:
the matching value.
Throws:
IllegalArgumentException - if the key is null or the empty string.
InvalidKeyException - if the key does not exist.

getAll

public Object[] getAll(String[] keys)
Returns the appropriate value for each key in the given array, using the same ordering.
Parameters:
keys - the keys whose values should be returned.
Returns:
the matching values.
Throws:
IllegalArgumentException - if one of the keys is null or the empty string.
InvalidKeyException - if one of the keys does not exist.

getCompositeType

public CompositeType getCompositeType()
Returns the composite type which corresponds to this instance of CompositeData.
Returns:
the composite type for this instance.

hashCode

public int hashCode()
Returns the hash code of this instance. The hash code is computed as the sum of the hash codes of all the values plus the hash code of the composite type. As equality comparisons take place using this same information, this ensures that the property, e1.equals(e2) implies e1.hashCode() == e2.hashCode(), holds for any pair of instances, e1 and e2.
Overrides:
hashCode in interface Object
Returns:
the hash code of this CompositeData.
See Also:
Object.equals(Object)

toString

public String toString()
Returns a textual representation of this instance. The exact format is left up to the implementation, but it should contain the name of the implementing class, the name of the type and a mapping of the form key=value for each pair of key and value.
Overrides:
toString in interface Object
Returns:
a String representation of the object.

values

public Collection values()
Returns a read-only collection of the values associated with this instance. The values are sorted using the lexicographic ordering of the corresponding keys.
Returns:
the values of this instance.
CompositeData.java -- A composite data structure. Copyright (C) 2006, 2007 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About