Module  java.management
软件包  javax.management.modelmbean

Class ModelMBeanAttributeInfo

  • All Implemented Interfaces:
    Serializable ， Cloneable ， DescriptorAccess ， DescriptorRead 

    public class ModelMBeanAttributeInfo
extends MBeanAttributeInfo
implements DescriptorAccess

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

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

    ModelMBeanAttributeInfo Fields Name Type Meaning name String Attribute name. descriptorType String Must be "attribute". value Object Current (cached) value for attribute. default Object Default value for attribute. displayName String Name of attribute to be used in displays. getMethod String Name of operation descriptor for get method. setMethod String Name of operation descriptor for set method. protocolMap Descriptor See the section "Protocol Map Support" in the JMX specification document. Mappings must be appropriate for the attribute and entries can be updated or augmented at runtime. persistPolicy String One of: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. See the section "MBean Descriptor Fields" in the JMX specification document. persistPeriod Number Frequency of persist cycle in seconds. Used when persistPolicy is "OnTimer" or "NoMoreOftenThan". currencyTimeLimit Number How long value is valid: <0 never, =0 always, >0 seconds. lastUpdatedTimeStamp Number When value was set. visibility Number 1-4 where 1: always visible, 4: rarely visible. presentationString String XML formatted string to allow presentation of data.

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

    注意：由于本规范的先前版本不一致，建议不要对currencyTimeLimit使用负值或零值。 要指示缓存值永远无效，请省略currencyTimeLimit字段。 要指示它始终有效，请在此字段中使用非常大的数字。

    该类的serialVersionUID为6181543027787327345L 。

    从以下版本开始：
    1.5
    另请参见：
    Serialized Form

    • 构造方法详细信息

      • ModelMBeanAttributeInfo

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

      • ModelMBeanAttributeInfo

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

      • ModelMBeanAttributeInfo

        public ModelMBeanAttributeInfo​(String name,
                               String type,
                               String description,
                               boolean isReadable,
                               boolean isWritable,
                               boolean isIs)
        使用默认描述符构造一个ModelMBeanAttributeInfo对象。
        参数
        name - 属性的名称
        type - 属性的类型或类名
        description - 属性的人类可读描述。
        isReadable - 如果属性具有getter方法， isReadable True，否则为false。
        isWritable - 如果属性具有setter方法， isWritable True，否则为false。
        isIs - 如果属性具有“is”getter， isIs True，否则为false。

      • ModelMBeanAttributeInfo

        public ModelMBeanAttributeInfo​(String name,
                               String type,
                               String description,
                               boolean isReadable,
                               boolean isWritable,
                               boolean isIs,
                               Descriptor descriptor)
        构造一个ModelMBeanAttributeInfo对象。
        参数
        name - 属性的名称
        type - 属性的类型或类名
        description - 属性的人类可读描述。
        isReadable - 如果属性具有getter方法， isReadable True，否则为false。
        isWritable - 如果属性具有setter方法， isWritable True，否则为false。
        isIs - 如果属性具有“is”getter， isIs True，否则为false。
        descriptor - 描述符的实例，其中包含此属性实例的适当元数据。 如果为空，则将创建默认描述符。 如果描述符不包含字段“displayName”，则该字段将添加到具有默认值的描述符中。
        异常
        RuntimeOperationsException - 包裹一个IllegalArgumentException。 描述符无效，或描述符字段“name”不等于name参数，或描述符字段“descriptorType”不等于“attribute”。

      • ModelMBeanAttributeInfo

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

    • 方法详细信息

      • setDescriptor

        public void setDescriptor​(Descriptor inDescriptor)
        为ModelMBeanAttributeDescriptor设置关联的描述符（完全替换）。 如果新的描述符为空，则关联的描述符将恢复为默认描述符。 描述符在分配之前验证。 如果新的Descriptor无效，则抛出一个包含IllegalArgumentException的RuntimeOperationsException。
        Specified by:
        setDescriptor在接口 DescriptorAccess
        参数
        inDescriptor - 替换与ModelMBeanAttributeInfo关联的描述符
        异常
        RuntimeOperationsException - 为无效的描述符包装一个IllegalArgumentException
        另请参见：
        getDescriptor()

      • clone

        public Object clone​()
        创建并返回一个新的ModelMBeanAttributeInfo，它与此ModelMBeanAttributeInfo重复。
        重写：
        clone在 MBeanAttributeInfo
        结果
        这个实例的一个克隆。
        异常
        RuntimeOperationsException - 用于字段名称或字段值的非法值。 如果由于任何原因描述符构造失败，将抛出此异常。
        另请参见：
        Cloneable

      • toString

        public String toString​()
        返回一个可读的ModelMBeanAttributeInfo实例版本。
        重写：
        toString在 MBeanAttributeInfo
        结果
        对象的字符串表示形式。