public class MBeanAttributeInfo extends MBeanFeatureInfo implements Cloneable
Describes an MBean attribute exposed for management. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.
description, name
public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
Constructs an MBeanAttributeInfo
object.
name
- The name of the attribute.type
- The type or class name of the attribute.description
- A human readable description of the attribute.isReadable
- True if the attribute has a getter method, false otherwise.isWritable
- True if the attribute has a setter method, false otherwise.isIs
- True if this attribute has an "is" getter, false otherwise.IllegalArgumentException
- if isIs
is true but isReadable
is not, or if isIs
is true and type
is not boolean
or java.lang.Boolean
. (New code should always use boolean
rather than java.lang.Boolean
.)public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Constructs an MBeanAttributeInfo
object.
name
- The name of the attribute.type
- The type or class name of the attribute.description
- A human readable description of the attribute.isReadable
- True if the attribute has a getter method, false otherwise.isWritable
- True if the attribute has a setter method, false otherwise.isIs
- True if this attribute has an "is" getter, false otherwise.descriptor
- The descriptor for the attribute. This may be null which is equivalent to an empty descriptor.IllegalArgumentException
- if isIs
is true but isReadable
is not, or if isIs
is true and type
is not boolean
or java.lang.Boolean
. (New code should always use boolean
rather than java.lang.Boolean
.)public MBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException
This constructor takes the name of a simple attribute, and Method objects for reading and writing the attribute. The Descriptor
of the constructed object will include fields contributed by any annotations on the Method
objects that contain the DescriptorKey
meta-annotation.
name
- The programmatic name of the attribute.description
- A human readable description of the attribute.getter
- The method used for reading the attribute value. May be null if the property is write-only.setter
- The method used for writing the attribute value. May be null if the attribute is read-only.IntrospectionException
- There is a consistency problem in the definition of this attribute.public Object clone()
Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone()
, thus calling the default native shallow cloning mechanism implemented by Object.clone()
. No deeper cloning of any internal field is made.
Since this class is immutable, cloning is chiefly of interest to subclasses.
public String getType()
Returns the class name of the attribute.
public boolean isReadable()
Whether the value of the attribute can be read.
public boolean isWritable()
Whether new values can be written to the attribute.
public boolean isIs()
Indicates if this attribute has an "is" getter.
public String toString()
Description copied from class: Object
Returns a string representation of the object. In general, the toString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public boolean equals(Object o)
Compare this MBeanAttributeInfo to another.
equals
in class MBeanFeatureInfo
o
- the object to compare to.o
is an MBeanAttributeInfo such that its MBeanFeatureInfo.getName()
, getType()
, MBeanFeatureInfo.getDescription()
, isReadable()
, isWritable()
, and isIs()
values are equal (not necessarily identical) to those of this MBeanAttributeInfo.Object.hashCode()
, HashMap
public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap
.
The general contract of hashCode
is:
hashCode
method must consistently return the same integer, provided no information used in equals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. equals(Object)
method, then calling the hashCode
method on each of the two objects must produce the same integer result. Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. As much as is reasonably practical, the hashCode method defined by class Object
does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
hashCode
in class MBeanFeatureInfo
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.