Top Description Fields Constructors Methods
javax.management

public Class MBeanAttributeInfo

extends MBeanFeatureInfo
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Known Direct Subclasses
javax.management.modelmbean.ModelMBeanAttributeInfo, javax.management.openmbean.OpenMBeanAttributeInfoSupport
Annotations
@SuppressWarnings:serial
Imports
java.lang.reflect.Method, java.security.AccessController, com.sun.jmx.mbeanserver.GetPropertyAction, .Introspector, java.util.Objects
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

Field Summary

Modifier and TypeField and Description
private final String
attributeType

private final boolean
is

private final boolean
isRead

private final boolean
isWrite

pack-priv static final MBeanAttributeInfo[]
NO_ATTRIBUTES

private static final long
serialVersionUID

Hides javax.management.MBeanFeatureInfo.serialVersionUID.

Inherited from javax.management.MBeanFeatureInfo:
descriptionname

Constructor Summary

AccessConstructor and Description
public
MBeanAttributeInfo(String
The name of the attribute.
name, String
The type or class name of the attribute.
type, String
A human readable description of the attribute.
description, boolean
True if the attribute has a getter method, false otherwise.
isReadable, boolean
True if the attribute has a setter method, false otherwise.
isWritable, boolean
True if this attribute has an "is" getter, false otherwise.
isIs)

Constructs an MBeanAttributeInfo object.

public
MBeanAttributeInfo(String
The name of the attribute.
name, String
The type or class name of the attribute.
type, String
A human readable description of the attribute.
description, boolean
True if the attribute has a getter method, false otherwise.
isReadable, boolean
True if the attribute has a setter method, false otherwise.
isWritable, boolean
True if this attribute has an "is" getter, false otherwise.
isIs, Descriptor
The descriptor for the attribute. This may be null which is equivalent to an empty descriptor.
descriptor)

Constructs an MBeanAttributeInfo object.

public
MBeanAttributeInfo(String
The programmatic name of the attribute.
name, String
A human readable description of the attribute.
description, Method
The method used for reading the attribute value. May be null if the property is write-only.
getter, Method
The method used for writing the attribute value. May be null if the attribute is read-only.
setter)

This constructor takes the name of a simple attribute, and Method objects for reading and writing the attribute.

Method Summary

Modifier and TypeMethod and Description
private static String
attributeType(Method getter, Method setter)

Finds the type of the attribute.

public Object
clone()

Overrides java.lang.Object.clone.

Returns a shallow clone of this instance.

public boolean

Returns:

true if and only if o is an MBeanAttributeInfo such that its getName(), getType(), getDescription(), isReadable(), isWritable(), and isIs() values are equal (not necessarily identical) to those of this MBeanAttributeInfo.
equals(Object
the object to compare to.
o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanAttributeInfo to another.

public String

Returns:

the class name.
getType()

Returns the class name of the attribute.

public int
hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if this attribute has an "is" getter.
isIs()

Indicates if this attribute has an "is" getter.

private static boolean
isIs(Method getter)

public boolean

Returns:

True if the attribute can be read, false otherwise.
isReadable()

Whether the value of the attribute can be read.

public boolean

Returns:

True if the attribute can be written to, false otherwise.
isWritable()

Whether new values can be written to the attribute.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from javax.management.MBeanFeatureInfo:
getDescriptiongetDescriptorgetName

Field Detail

attributeTypeback to summary
private final String attributeType
isback to summary
private final boolean is
isReadback to summary
private final boolean isRead
isWriteback to summary
private final boolean isWrite
NO_ATTRIBUTESback to summary
pack-priv static final MBeanAttributeInfo[] NO_ATTRIBUTES
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.management.MBeanFeatureInfo.serialVersionUID.

Constructor Detail

MBeanAttributeInfoback to summary
public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)

Constructs an MBeanAttributeInfo object.

Parameters
name:String

The name of the attribute.

type:String

The type or class name of the attribute.

description:String

A human readable description of the attribute.

isReadable:boolean

True if the attribute has a getter method, false otherwise.

isWritable:boolean

True if the attribute has a setter method, false otherwise.

isIs:boolean

True if this attribute has an "is" getter, false otherwise.

Exceptions
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.)
MBeanAttributeInfoback to summary
public MBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)

Constructs an MBeanAttributeInfo object.

Parameters
name:String

The name of the attribute.

type:String

The type or class name of the attribute.

description:String

A human readable description of the attribute.

isReadable:boolean

True if the attribute has a getter method, false otherwise.

isWritable:boolean

True if the attribute has a setter method, false otherwise.

isIs:boolean

True if this attribute has an "is" getter, false otherwise.

descriptor:Descriptor

The descriptor for the attribute. This may be null which is equivalent to an empty descriptor.

Exceptions
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.)
Since
1.6
MBeanAttributeInfoback to summary
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.

Parameters
name:String

The programmatic name of the attribute.

description:String

A human readable description of the attribute.

getter:Method

The method used for reading the attribute value. May be null if the property is write-only.

setter:Method

The method used for writing the attribute value. May be null if the attribute is read-only.

Exceptions
IntrospectionException:
There is a consistency problem in the definition of this attribute.

Method Detail

attributeTypeback to summary
private static String attributeType(Method getter, Method setter) throws IntrospectionException

Finds the type of the attribute.

cloneback to summary
public Object clone()

Overrides java.lang.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.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

equalsback to summary
public boolean equals(Object o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanAttributeInfo to another.

Parameters
o:Object

the object to compare to.

Returns:boolean

true if and only if o is an MBeanAttributeInfo such that its getName(), getType(), getDescription(), isReadable(), isWritable(), and isIs() values are equal (not necessarily identical) to those of this MBeanAttributeInfo.

getTypeback to summary
public String getType()

Returns the class name of the attribute.

Returns:String

the class name.

hashCodeback to summary
public int hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

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 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.
  • If two objects are equal according to the equals method, then calling the hashCode 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 equals 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.
Returns:int

a hash code value for this object

isIsback to summary
public boolean isIs()

Indicates if this attribute has an "is" getter.

Returns:boolean

true if this attribute has an "is" getter.

isIsback to summary
private static boolean isIs(Method getter)
isReadableback to summary
public boolean isReadable()

Whether the value of the attribute can be read.

Returns:boolean

True if the attribute can be read, false otherwise.

isWritableback to summary
public boolean isWritable()

Whether new values can be written to the attribute.

Returns:boolean

True if the attribute can be written to, false otherwise.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object