CompositeData (JBoss/JMX API) - JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.openmbean
Interface CompositeData

All Known Implementing Classes:: CompositeDataSupport

public interface CompositeData

An Open Data Type for composite data structures.

Version:: $Revision: 1.4 $
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

public CompositeType getCompositeType()

Retrieve the composite type for this composite data

Returns:: the composite type

get

public Object get(String key)

Retrieve the value for the item with the passed key

Returns:: the value
Throws:: IllegalArgumentException - when the key is null or the empty string; InvalidKeyException - when the key does not exist

getAll

public Object[] getAll(String[] key)

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

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

public boolean containsKey(String key)

Tests whether a key is part of this composite data

Returns:: true when the key exists, false otherwise

containsValue

public boolean containsValue(Object value)

Tests whether a item exists with the passed value

Returns:: true when the value exists, false otherwise

values

public 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

public 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

Parameters:: obj - the object to test
Returns:: true when the above conditions are satisfied, false otherwise.

hashCode

public int hashCode()

Generates a hashcode for the implementation.

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

Returns:: the calculated hashcode

toString

public 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

Returns:: the string