FileDocCategorySizeDatePackage
OpenMBeanAttributeInfo.javaAPI DocJava SE 5 API4563Fri Aug 26 14:57:36 BST 2005javax.management.openmbean

OpenMBeanAttributeInfo

public interface OpenMBeanAttributeInfo implements 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}.

version
3.20 03/12/19
author
Sun Microsystems, Inc.
since
1.5
since.unbundled
JMX 1.1

Fields Summary
Constructors Summary
Methods Summary
public booleanequals(java.lang.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.
 

param
obj the object to be compared for equality with this OpenMBeanAttributeInfo instance;
return
true if the specified object is equal to this OpenMBeanAttributeInfo instance.

public inthashCode()
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()}.

return
the hash code value for this OpenMBeanAttributeInfo instance

public booleanisIs()
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.

return
true if the attribute is accessed through isXXX.

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

return
true if the attribute is readable.

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

return
true if the attribute is writable.

public java.lang.StringtoString()
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.

return
a string representation of this OpenMBeanAttributeInfo instance