Class MBeanAttributeInfo
- 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 inherited from class javax.management.MBeanFeatureInfo
description, name
-
-
Constructor Summary
Constructors Constructor and 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
All Methods Instance Methods Concrete Methods Modifier and Type Method and 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.int
hashCode()
Returns a hash code value for the object.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.String
toString()
Returns a string representation of the object.-
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
-
-
-
Constructor Detail
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 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 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 Detail
clone
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.
getType
public String 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.
toString
public String toString()
Description copied from class:Object
Returns a string representation of the object. In general, thetoString
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 classObject
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())
equals
public boolean equals(Object o)
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
hashCode
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 byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
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. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
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.)- Overrides:
-
hashCode
in classMBeanFeatureInfo
- Returns:
- a hash code value for this object.
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.