MBeanAttributeInfo (Java SE 19 & JDK 19) (original) (raw)

All Implemented Interfaces:

[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io"), [Cloneable](../../../java.base/java/lang/Cloneable.html "interface in java.lang"), [DescriptorRead](DescriptorRead.html "interface in javax.management")

Direct Known Subclasses:

[ModelMBeanAttributeInfo](modelmbean/ModelMBeanAttributeInfo.html "class in javax.management.modelmbean"), [OpenMBeanAttributeInfoSupport](openmbean/OpenMBeanAttributeInfoSupport.html "class in javax.management.openmbean")

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

• Constructor Summary

Constructors
This constructor takes the name of a simple attribute, and Method objects for reading and writing the attribute.
[MBeanAttributeInfo](#%3Cinit%3E%28java.lang.String,java.lang.String,java.lang.String,boolean,boolean,boolean%29)([String](../../../java.base/java/lang/String.html "class in java.lang") name,[String](../../../java.base/java/lang/String.html "class in java.lang") type,[String](../../../java.base/java/lang/String.html "class in java.lang") description, boolean isReadable, boolean isWritable, boolean isIs)
Constructs an MBeanAttributeInfo object.
[MBeanAttributeInfo](#%3Cinit%3E%28java.lang.String,java.lang.String,java.lang.String,boolean,boolean,boolean,javax.management.Descriptor%29)([String](../../../java.base/java/lang/String.html "class in java.lang") name,[String](../../../java.base/java/lang/String.html "class in java.lang") type,[String](../../../java.base/java/lang/String.html "class in java.lang") description, boolean isReadable, boolean isWritable, boolean isIs,[Descriptor](Descriptor.html "interface in javax.management") descriptor)
Constructs an MBeanAttributeInfo object.

• Method Summary

[clone](#clone%28%29)()
Returns a shallow clone of this instance.
boolean
Compare this MBeanAttributeInfo to another.
[getType](#getType%28%29)()
Returns the class name of the attribute.
boolean
[isIs](#isIs%28%29)()
Indicates if this attribute has an "is" getter.
boolean
Whether the value of the attribute can be read.
boolean
Whether new values can be written to the attribute.

• Constructor Details

  • MBeanAttributeInfo

  public MBeanAttributeInfo(String name,String type,String description, boolean isReadable, boolean isWritable, boolean isIs)
  Constructs an MBeanAttributeInfo 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](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - if isIs is true butisReadable is not, or if isIs is true andtype is not boolean or java.lang.Boolean. (New code should always use boolean rather thanjava.lang.Boolean.)

  • MBeanAttributeInfo

  public MBeanAttributeInfo(String name,String type,String description, boolean isReadable, boolean isWritable, boolean isIs,Descriptor descriptor)
  Constructs an MBeanAttributeInfo 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](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - if isIs is true butisReadable is not, or if isIs is true andtype is not boolean or java.lang.Boolean. (New code should always use boolean rather thanjava.lang.Boolean.)
  Since:
  1.6

  • MBeanAttributeInfo

  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 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](IntrospectionException.html "class in javax.management") - 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 by Object.clone(). No deeper cloning of any internal field is made.
  Since this class is immutable, cloning is chiefly of interest to subclasses.
  Overrides:
  [clone](../../../java.base/java/lang/Object.html#clone%28%29) in class [Object](../../../java.base/java/lang/Object.html "class in java.lang")
  Returns:
  a clone of this instance.
  See Also:
  * Cloneable

  • 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

  public boolean equals(Object o)
  Compare this MBeanAttributeInfo to another.
  Overrides:
  [equals](MBeanFeatureInfo.html#equals%28java.lang.Object%29) in class [MBeanFeatureInfo](MBeanFeatureInfo.html "class in javax.management")
  Parameters:
  o - the object to compare to.
  Returns:
  true if and only if 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.
  See Also:
  * Object.hashCode()
  * HashMap