java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
- All Implemented Interfaces:
Serializable
,Cloneable
,DescriptorRead
- Direct Known Subclasses:
ModelMBeanAttributeInfo
,OpenMBeanAttributeInfoSupport
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.
- Since:
- 1.5
- See Also:
- Serialized Form
-
Field Summary
Fields declared in class javax.management.MBeanFeatureInfo
description, name
-
Constructor Summary
Constructors Constructor Description MBeanAttributeInfo(String name, String description, Method getter, Method setter)
This constructor takes the name of a simple attribute, and Method objects for reading and writing the attribute.MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
Constructs anMBeanAttributeInfo
object.MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Constructs anMBeanAttributeInfo
object. -
Method Summary
Modifier and Type Method Description Object
clone()
Returns a shallow clone of this instance.boolean
equals(Object o)
Compare this MBeanAttributeInfo to another.String
getType()
Returns the class name of the attribute.boolean
isIs()
Indicates if this attribute has an "is" getter.boolean
isReadable()
Whether the value of the attribute can be read.boolean
isWritable()
Whether new values can be written to the attribute.Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
Constructor Details
-
MBeanAttributeInfo
public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)Constructs anMBeanAttributeInfo
object.- Parameters:
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.- Throws:
IllegalArgumentException
- ifisIs
is true butisReadable
is not, or ifisIs
is true andtype
is notboolean
orjava.lang.Boolean
. (New code should always useboolean
rather thanjava.lang.Boolean
.)
-
MBeanAttributeInfo
public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)Constructs anMBeanAttributeInfo
object.- Parameters:
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.- Throws:
IllegalArgumentException
- ifisIs
is true butisReadable
is not, or ifisIs
is true andtype
is notboolean
orjava.lang.Boolean
. (New code should always useboolean
rather thanjava.lang.Boolean
.)- Since:
- 1.6
-
MBeanAttributeInfo
public MBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionExceptionThis 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 theMethod
objects that contain theDescriptorKey
meta-annotation.- Parameters:
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.- Throws:
IntrospectionException
- There is a consistency problem in the definition of this attribute.
-
-
Method Details
-
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 byObject.clone()
. No deeper cloning of any internal field is made.Since this class is immutable, cloning is chiefly of interest to subclasses.
-
getType
Returns the class name of the attribute.- Returns:
- the class name.
-
isReadable
public boolean isReadable()Whether the value of the attribute can be read.- Returns:
- True if the attribute can be read, false otherwise.
-
isWritable
public boolean isWritable()Whether new values can be written to the attribute.- Returns:
- True if the attribute can be written to, false otherwise.
-
isIs
public boolean isIs()Indicates if this attribute has an "is" getter.- Returns:
- true if this attribute has an "is" getter.
-
equals
Compare this MBeanAttributeInfo to another.- Overrides:
equals
in classMBeanFeatureInfo
- Parameters:
o
- the object to compare to.- Returns:
- true if and only if
o
is an MBeanAttributeInfo such that itsMBeanFeatureInfo.getName()
,getType()
,MBeanFeatureInfo.getDescription()
,isReadable()
,isWritable()
, andisIs()
values are equal (not necessarily identical) to those of this MBeanAttributeInfo. - See Also:
Object.hashCode()
,HashMap
-