模块  java.management
软件包  javax.management.modelmbean

Class ModelMBeanAttributeInfo

  • 实现的所有接口
    Serializable ， Cloneable ， DescriptorAccess ， DescriptorRead 
    public class ModelMBeanAttributeInfo
extends MBeanAttributeInfo
implements DescriptorAccess

    ModelMBeanAttributeInfo对象描述了ModelMBean的一个属性。 它是MBeanAttributeInfo的子类，添加了关联的Descriptor和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.

    默认描述符包含name，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 - 描述符的实例，包含此Attribute实例的相应元数据。 如果为null，则将创建默认描述符。 如果描述符不包含字段“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，则为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，则为true，否则为false。
        descriptor - 描述符的实例，包含此Attribute实例的相应元数据。 如果为null，则将创建默认描述符。 如果描述符不包含字段“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在类 Object
        结果
        对象的字符串表示形式。