APIdia Launch Partner
Top Description Methods
javax.management.openmbean

public Interface OpenMBeanAttributeInfo

extends OpenMBeanParameterInfo
Known Direct Implementers
javax.management.openmbean.OpenMBeanAttributeInfoSupport

Describes an attribute of an open MBean.

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

Since
1.5

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the specified object is equal to this OpenMBeanAttributeInfo instance.
equals
(Object
the object to be compared for equality with this OpenMBeanAttributeInfo instance;
obj
)

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.equals.

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

public int

Returns:

the hash code value for this OpenMBeanAttributeInfo instance
hashCode
()

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.hashCode.

Returns the hash code value for this OpenMBeanAttributeInfo instance.

public boolean

Returns:

true if the attribute is accessed through isXXX.
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.

public boolean

Returns:

true if the attribute is readable.
isReadable
()

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

public boolean

Returns:

true if the attribute is writable.
isWritable
()

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

public String

Returns:

a string representation of this OpenMBeanAttributeInfo instance
toString
()

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.toString.

Returns a string representation of this OpenMBeanAttributeInfo instance.

Inherited from javax.management.openmbean.OpenMBeanParameterInfo:
getDefaultValuegetDescriptiongetLegalValuesgetMaxValuegetMinValuegetNamegetOpenTypehasDefaultValuehasLegalValueshasMaxValuehasMinValueisValue

Method Detail

equalsback to summary
public boolean equals(Object obj)

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.equals.

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.
 
Parameters
obj:Object

the object to be compared for equality with this OpenMBeanAttributeInfo instance;

Returns:boolean

true if the specified object is equal to this OpenMBeanAttributeInfo instance.

hashCodeback to summary
public int hashCode()

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.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 Object.hashCode().

Returns:int

the hash code value for this OpenMBeanAttributeInfo instance

isIsback to summary
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:boolean

true if the attribute is accessed through isXXX.

isReadableback to summary
public boolean isReadable()

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

Returns:boolean

true if the attribute is readable.

isWritableback to summary
public boolean isWritable()

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

Returns:boolean

true if the attribute is writable.

toStringback to summary
public String toString()

Redeclares javax.management.openmbean.OpenMBeanParameterInfo.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.

Returns:String

a string representation of this OpenMBeanAttributeInfo instance