Module java.management
Package javax.management.modelmbean

Class ModelMBeanAttributeInfo

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
javax.management.modelmbean.ModelMBeanAttributeInfo
所有已实现的接口:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess

ModelMBeanAttributeInfo对象描述了ModelMBean的属性。它是MBeanAttributeInfo的子类，增加了一个关联的描述符和DescriptorAccess接口的实现。

描述符中的字段被定义，但不限于以下内容。请注意，当此表中的类型为Number时，也可以使用Long的十进制表示形式的字符串。

ModelMBeanAttributeInfo字段
名称 类型 含义
name String 属性名称。
descriptorType String 必须是"attribute"。
value Object 属性的当前（缓存的）值。
default Object 属性的默认值。
displayName String 用于显示的属性名称。
getMethod String 获取方法的操作描述符名称。
setMethod String 设置方法的操作描述符名称。
protocolMap Descriptor 请参阅JMX规范文档中的"协议映射支持"部分。映射必须适用于属性，条目可以在运行时更新或增加。
persistPolicy String 其中之一: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never。请参阅JMX规范文档中的"MBean描述符字段"部分。
persistPeriod Number 持久化周期的频率（以秒为单位）。当persistPolicy为"OnTimer"或"NoMoreOftenThan"时使用。
currencyTimeLimit Number value 的有效期：<0 永不，=0 总是，>0 秒。
lastUpdatedTimeStamp Number value 设置的时间戳。
visibility Number 1-4 其中 1: 总是可见，4: 很少可见。
presentationString String XML格式的字符串，用于呈现数据。

默认描述符包含名称、descriptorType 和 displayName 字段。名称和 displayName 字段的默认值为属性的名称。

注意:由于此规范先前版本中的不一致性，建议不要对 currencyTimeLimit 使用负值或零值。要表示缓存值永远无效，请省略 currencyTimeLimit 字段。要表示它总是有效，请为此字段使用一个非常大的数字。

此类的serialVersionUID为 6181543027787327345L。

自:
1.5
参见:

  • Constructor Details

    • ModelMBeanAttributeInfo

      public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException
      构造具有默认描述符的ModelMBeanAttributeInfo对象。构造对象的描述符将包含包含具有DescriptorKey元注释的Method对象上的任何注释贡献的字段。
      参数:
      name - 属性的名称。
      description - 属性的人类可读描述。可选的。
      getter - 用于读取属性值的方法。如果属性是只写的，则可能为null。
      setter - 用于写入属性值的方法。如果属性是只读的，则可能为null。
      抛出:
      IntrospectionException - 此属性定义中存在一致性问题。

    • ModelMBeanAttributeInfo

      public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) throws IntrospectionException
      构造ModelMBeanAttributeInfo对象。构造对象的描述符将包含包含具有DescriptorKey元注释的Method对象上的任何注释贡献的字段。
      参数:
      name - 属性的名称。
      description - 属性的人类可读描述。可选的。
      getter - 用于读取属性值的方法。如果属性是只写的，则可能为null。
      setter - 用于写入属性值的方法。如果属性是只读的，则可能为null。
      descriptor - 包含此属性实例的适当元数据的Descriptor实例。如果为null，则将创建默认描述符。如果描述符不包含字段"displayName"，则在描述符中添加此字段及其默认值。
      抛出:
      IntrospectionException - 此属性定义中存在一致性问题。
      RuntimeOperationsException - 包装IllegalArgumentException。描述符无效，或描述符字段"name"不等于名称参数，或描述符字段"descriptorType"不等于"attribute"。

    • ModelMBeanAttributeInfo

      public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
      构造具有默认描述符的ModelMBeanAttributeInfo对象。
      参数:
      name - 属性的名称
      type - 属性的类型或类名
      description - 属性的人类可读描述
      isReadable - 如果属性具有获取方法，则为true，否则为false。
      isWritable - 如果属性具有设置方法，则为true，否则为false。
      isIs - 如果属性具有"is"获取方法，则为true，否则为false。

    • ModelMBeanAttributeInfo

      public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
      构造ModelMBeanAttributeInfo对象。
      参数:
      name - 属性的名称
      type - 属性的类型或类名
      description - 属性的人类可读描述
      isReadable - 如果属性具有获取方法，则为true，否则为false。
      isWritable - 如果属性具有设置方法，则为true，否则为false。
      isIs - 如果属性具有"is"获取方法，则为true，否则为false。
      descriptor - 包含此属性实例的适当元数据的Descriptor实例。如果为null，则将创建默认描述符。如果描述符不包含字段"displayName"，则在描述符中添加此字段及其默认值。
      抛出:
      RuntimeOperationsException - 包装IllegalArgumentException。描述符无效，或描述符字段"name"不等于名称参数，或描述符字段"descriptorType"不等于"attribute"。

    • ModelMBeanAttributeInfo

      public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
      从此ModelMBeanAttributeInfo对象构造一个新的ModelMBeanAttributeInfo对象。将创建一个默认描述符。
      参数:
      inInfo - 要复制的ModelMBeanAttributeInfo

  • Method Details

    • getDescriptor

      public Descriptor getDescriptor()
      获取ModelMBeanAttributeInfo的关联描述符的副本。
      指定者:
      getDescriptor 在接口 DescriptorRead中
      覆盖:
      getDescriptor 在类 MBeanFeatureInfo中
      返回:
      与ModelMBeanAttributeInfo对象关联的描述符。
      参见:

    • setDescriptor

      public void setDescriptor(Descriptor inDescriptor)
      为ModelMBeanAttributeDescriptor设置关联描述符（完全替换）。如果新的描述符为null，则关联描述符将恢复为默认描述符。在分配描述符之前，将验证描述符。如果新的描述符无效，则会抛出包装IllegalArgumentException的RuntimeOperationsException。
      指定者:
      setDescriptor 在接口 DescriptorAccess
      参数:
      inDescriptor - 替换与ModelMBeanAttributeInfo关联的描述符
      抛出:
      RuntimeOperationsException - 封装了一个非法描述符的IllegalArgumentException
      参见:

    • clone

      public Object clone()
      创建并返回一个新的ModelMBeanAttributeInfo，它是此ModelMBeanAttributeInfo的副本。
      覆盖:
      clone 在类 MBeanAttributeInfo
      返回:
      此实例的克隆。
      抛出:
      RuntimeOperationsException - 对于字段名称或字段值的非法值。如果描述符的构建由于任何原因失败，将抛出此异常。
      参见:

    • toString

      public String toString()
      返回ModelMBeanAttributeInfo实例的可读版本。
      覆盖:
      toString 在类 Object
      返回:
      对象的字符串表示形式。