OpenMBeanAttributeInfo (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.openmbean
interface OpenMBeanAttributeInfo

All Superinterfaces:: OpenMBeanParameterInfo

All Known Implementing Classes:: OpenMBeanAttributeInfoSupport

public interface OpenMBeanAttributeInfo
extends OpenMBeanParameterInfo

Describes an attribute of an open MBean.

This interface declares the same methods as the class {@link javax.management.MBeanAttributeInfo}. A class implementing this interface (typically {@link OpenMBeanAttributeInfoSupport}) should extend {@link javax.management.MBeanAttributeInfo}.

Method Summary
`boolean`	`equals(Object obj)` Compares the specified `obj` parameter with this `OpenMBeanAttributeInfo` instance for equality.
`int`	`hashCode()` Returns the hash code value for this `OpenMBeanAttributeInfo` instance.
`boolean`	`isIs()` Returns `true` if the attribute described by this `OpenMBeanAttributeInfo` instance is accessed through a `isXXX` getter (applies only to `boolean` and `Boolean` values), `false` otherwise.
`boolean`	`isReadable()` Returns `true` if the attribute described by this `OpenMBeanAttributeInfo` instance is readable, `false` otherwise.
`boolean`	`isWritable()` Returns `true` if the attribute described by this `OpenMBeanAttributeInfo` instance is writable, `false` otherwise.
`String`	`toString()` Returns a string representation of this `OpenMBeanAttributeInfo` instance.

Methods inherited from class javax.management.openmbean.OpenMBeanParameterInfo
`equals, getDefaultValue, getDescription, getLegalValues, getMaxValue, getMinValue, getName, getOpenType, hasDefaultValue, hashCode, hasLegalValues, hasMaxValue, hasMinValue, isValue, toString`

Method Detail

equals

public boolean equals(Object obj)

Compares the specified obj parameter with this OpenMBeanAttributeInfo instance for equality.

Returns true if and only if all of the following statements are true:

obj is non null,
obj also implements the OpenMBeanAttributeInfo interface,
their names are equal
their open types are equal
their access properties (isReadable, isWritable and isIs) are equal
their default, min, max and legal values are equal.

This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanAttributeInfo interface.

Overrides:: equals in class Object
Parameters:: obj - the object to be compared for equality with this OpenMBeanAttributeInfo instance;
Returns:: true if the specified object is equal to this OpenMBeanAttributeInfo instance.

hashCode

public int hashCode()

Returns the hash code value for this OpenMBeanAttributeInfo instance.

The hash code of an OpenMBeanAttributeInfo instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: its name, its open type, and its default, min, max and legal values).

This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two OpenMBeanAttributeInfo instances t1 and t2, as required by the general contract of the method {@link Object#hashCode() Object.hashCode()}.

Overrides:: hashCode in class Object
Returns:: the hash code value for this OpenMBeanAttributeInfo instance

isIs

public boolean isIs()

Returns true if the attribute described by this OpenMBeanAttributeInfo instance is accessed through a isXXX getter (applies only to boolean and Boolean values), false otherwise.

Returns:: true if the attribute is accessed through isXXX.

isReadable

public boolean isReadable()

Returns true if the attribute described by this OpenMBeanAttributeInfo instance is readable, false otherwise.

Returns:: true if the attribute is readable.

isWritable

public boolean isWritable()

Returns true if the attribute described by this OpenMBeanAttributeInfo instance is writable, false otherwise.

Returns:: true if the attribute is writable.

toString

public String toString()

Returns a string representation of this OpenMBeanAttributeInfo instance.

The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanAttributeInfo), the string representation of the name and open type of the described attribute, and the string representation of its default, min, max and legal values.

Overrides:: toString in class Object
Returns:: a string representation of this OpenMBeanAttributeInfo instance