javax.management.openmbean
Interface CompositeData

All Known Implementing Classes:

CompositeDataSupport

public interface CompositeData

An Open Data Type for composite data structures.

Version:

$Revision: 57200 $

Author:

Adrian Brock.

See Also:

CompositeDataSupport

Method Summary

boolean	containsKey(String key) Tests whether a key is part of this composite data
boolean	containsValue(Object value) Tests whether a item exists with the passed value
boolean	equals(Object obj) Tests whether two composite data objects are equal
Object	get(String key) Retrieve the value for the item with the passed key
Object[]	getAll(String[] key) Retrieve the arrray of values for the item with the passed keys
CompositeType	getCompositeType() Retrieve the composite type for this composite data
int	hashCode() Generates a hashcode for the implementation.
String	toString() A string representation of the open mbean operation info.
Collection	values() The values of this composite data

Method Detail

getCompositeType

CompositeType getCompositeType()

Retrieve the composite type for this composite data

Returns:

the composite type

get

Object get(String key)

Retrieve the value for the item with the passed key

Parameters:

the - key to the item

Returns:

the value

Throws:

IllegalArgumentException - when the key is null or the empty string

InvalidKeyException - when the key does not exist

getAll

Object[] getAll(String[] key)

Retrieve the arrray of values for the item with the passed keys

Parameters:

an - array of key values

Returns:

the array of values

Throws:

IllegalArgumentException - when a key is null or the empty string or the array is null

InvalidKeyException - when a key does not exist

containsKey

boolean containsKey(String key)

Tests whether a key is part of this composite data

Parameters:

the - key to test

Returns:

true when the key exists, false otherwise

containsValue

boolean containsValue(Object value)

Tests whether a item exists with the passed value

Parameters:

the - value to test

Returns:

true when the value exists, false otherwise

values

Collection values()

The values of this composite data

An iterator over the returned collection returns result in ascending lexicographic order

Returns:

an unmodifiable Collection of the values of this CompositeType.

equals

boolean equals(Object obj)

Tests whether two composite data objects are equal

The object is non-null
The object implements this interface
The composite types are equal
The values are equal

Overrides:

equals in class Object

Parameters:

obj - the object to test

Returns:

true when the above conditions are satisfied, false otherwise.

hashCode

int hashCode()

Generates a hashcode for the implementation.

The sum of the hashCodes for the elements mentioned in the equals method

Overrides:

hashCode in class Object

Returns:

the calculated hashcode

toString

String toString()

A string representation of the open mbean operation info.

It is made up of implementation class and the values mentioned in the equals method

Overrides:

toString in class Object

Returns:

the string