Module java.management
Package javax.management.openmbean

Class OpenMBeanAttributeInfoSupport

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
javax.management.openmbean.OpenMBeanAttributeInfoSupport
所有实现的接口:
Serializable, Cloneable, DescriptorRead, OpenMBeanAttributeInfo, OpenMBeanParameterInfo
public class OpenMBeanAttributeInfoSupport extends MBeanAttributeInfo implements OpenMBeanAttributeInfo
描述开放MBean的属性。
自从:
1.5
参见:

  • Field Summary

    Fields declared in class javax.management.MBeanFeatureInfo

    description, name

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)
    构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType和description的开放MBean的属性，并指定读/写访问属性。
    OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
    构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description、读/写访问属性和Descriptor的开放MBean的属性。
    OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue)
    构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description和defaultValue的开放MBean的属性，并指定读/写访问属性。
    OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
    构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description、defaultValue、minValue和maxValue的开放MBean的属性。
    OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues)
    构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description、defaultValue和legalValues的开放MBean的属性，并指定读/写访问属性。

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    将指定的obj参数与此OpenMBeanAttributeInfoSupport实例进行比较，以确定它们是否相等。
    Object
    getDefaultValue()
    返回由此OpenMBeanAttributeInfoSupport实例描述的属性的默认值，如果指定了的话，否则返回null。
    Set<?>
    getLegalValues()
    返回由此OpenMBeanAttributeInfoSupport实例描述的属性的合法值的不可修改集合，如果指定了的话，否则返回null。
    Comparable<?>
    getMaxValue()
    返回由此OpenMBeanAttributeInfoSupport实例描述的属性的最大值，如果指定了的话，否则返回null。
    Comparable<?>
    getMinValue()
    返回由此OpenMBeanAttributeInfoSupport实例描述的属性的最小值，如果指定了的话，否则返回null。
    OpenType<?>
    getOpenType()
    返回由此OpenMBeanAttributeInfoSupport实例描述的属性值的开放类型。
    boolean
    hasDefaultValue()
    如果此OpenMBeanAttributeInfoSupport实例为所描述的属性指定了非空默认值，则返回true，否则返回false。
    int
    hashCode()
    返回此OpenMBeanAttributeInfoSupport实例的哈希码值。
    boolean
    hasLegalValues()
    如果此OpenMBeanAttributeInfoSupport实例为所描述的属性指定了非空合法值集合，则返回true，否则返回false。
    boolean
    hasMaxValue()
    如果此OpenMBeanAttributeInfoSupport实例为所描述的属性指定了非空最大值，则返回true，否则返回false。
    boolean
    hasMinValue()
    如果此OpenMBeanAttributeInfoSupport实例为所描述的属性指定了非空最小值，则返回true，否则返回false。
    boolean
    isValue(Object obj)
    测试obj是否是由此OpenMBeanAttributeInfoSupport实例描述的属性的有效值。
    String
    toString()
    返回此OpenMBeanAttributeInfoSupport实例的字符串表示形式。

    Methods declared in class javax.management.MBeanAttributeInfo

    clone, getType, isIs, isReadable, isWritable

    Methods declared in class javax.management.MBeanFeatureInfo

    getDescription, getDescriptor, getName

    Methods declared in class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods declared in interface javax.management.openmbean.OpenMBeanAttributeInfo

    isIs, isReadable, isWritable

    Methods declared in interface javax.management.openmbean.OpenMBeanParameterInfo

    getDescription, getName

  • Constructor Details

    • OpenMBeanAttributeInfoSupport

      public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)
      构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType和description的开放MBean的属性，并指定读/写访问属性。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      isReadable - 如果属性具有为管理公开的getter，则为true。
      isWritable - 如果属性具有为管理公开的setter，则为true。
      isIs - 如果属性的getter形式为isXXX，则为true。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。

    • OpenMBeanAttributeInfoSupport

      public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)

      构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description、读/写访问属性和Descriptor的开放MBean的属性。

      descriptor可以包含条目，这些条目将定义此类某些方法返回的值，如包描述中所述。

      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      isReadable - 如果属性具有为管理公开的getter，则为true。
      isWritable - 如果属性具有为管理公开的setter，则为true。
      isIs - 如果属性的getter形式为isXXX，则为true。
      descriptor - 属性的描述符。这可能为null，相当于空描述符。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null，或描述符条目无效，如包描述中所述。
      自从:
      1.6

    • OpenMBeanAttributeInfoSupport

      public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue) throws OpenDataException
      构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description和defaultValue的开放MBean的属性，并指定读/写访问属性。
      类型参数:
      T - 允许编译器检查defaultValue（如果非null）是否具有给定openType的正确Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      isReadable - 如果属性具有为管理公开的getter，则为true。
      isWritable - 如果属性具有为管理公开的setter，则为true。
      isIs - 如果属性的getter形式为isXXX，则为true。
      defaultValue - 必须是此属性指定的openType的有效值；不支持默认值ArrayType和TabularType；可以为null，表示未设置默认值。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。
      OpenDataException - 如果defaultValue不是指定openType的有效值，或defaultValue非null且openType为ArrayType或TabularType。

    • OpenMBeanAttributeInfoSupport

      public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues) throws OpenDataException

      构造一个OpenMBeanAttributeInfoSupport实例，描述具有指定name、openType、description、defaultValue和legalValues的开放MBean的属性，并指定读/写访问属性。

      legalValues的内容将被复制，因此对legalValues引用的数组的后续修改不会影响此OpenMBeanAttributeInfoSupport实例。

      类型参数:
      T - 允许编译器检查defaultValue和legalValues（如果非空）对于给定openType具有正确的Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      isReadable - 如果属性具有用于管理的公开的getter，则为true。
      isWritable - 如果属性具有用于管理的公开的setter，则为true。
      isIs - 如果属性的getter形式为isXXX，则为true。
      defaultValue - 必须是为此属性指定的openType的有效值；不支持默认值ArrayType和TabularType；可以为null，此时表示未设置默认值。
      legalValues - 每个包含的值必须是为此属性指定的openType的有效值；不支持合法值ArrayType和TabularType；可以为null或空。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。
      OpenDataException - 如果defaultValue不是指定openType的有效值，或legalValues中的一个值不是指定openType的有效值，或defaultValue非null且openType为ArrayType或TabularType，或legalValues非null且非空且openType为ArrayType或TabularType，或legalValues非null且非空且defaultValue不包含在legalValues中。

    • OpenMBeanAttributeInfoSupport

      public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
      构造一个OpenMBeanAttributeInfoSupport实例，描述开放MBean的属性，具有指定的name、openType、description、defaultValue、minValue和maxValue。只能为值为Comparable的开放类型指定最小和最大值。
      类型参数:
      T - 允许编译器检查defaultValue、minValue和maxValue（如果非空）对于给定openType具有正确的Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      isReadable - 如果属性具有用于管理的公开的getter，则为true。
      isWritable - 如果属性具有用于管理的公开的setter，则为true。
      isIs - 如果属性的getter形式为isXXX，则为true。
      defaultValue - 必须是为此属性指定的openType的有效值；不支持默认值ArrayType和TabularType；可以为null，此时表示未设置默认值。
      minValue - 必须对于此属性指定的openType有效；可以为null，此时表示未设置最小值。
      maxValue - 必须对于此属性指定的openType有效；可以为null，此时表示未设置最大值。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。
      OpenDataException - 如果defaultValue、minValue或maxValue不是指定openType的有效值，或defaultValue非null且openType为ArrayType或TabularType，或minValue和maxValue均非null且minValue.compareTo(maxValue) > 0为true，或defaultValue和minValue均非null且minValue.compareTo(defaultValue) > 0为true，或defaultValue和maxValue均非null且defaultValue.compareTo(maxValue) > 0为true。

  • Method Details

    • getOpenType

      public OpenType<?> getOpenType()
      返回由此OpenMBeanAttributeInfoSupport实例描述的属性的值的开放类型。
      指定者:
      getOpenType 在接口 OpenMBeanParameterInfo
      返回:
      开放类型。

    • getDefaultValue

      public Object getDefaultValue()
      返回由此OpenMBeanAttributeInfoSupport实例描述的属性的默认值（如果指定），否则返回null。
      指定者:
      getDefaultValue 在接口 OpenMBeanParameterInfo
      返回:
      默认值。

    • getLegalValues

      public Set<?> getLegalValues()
      返回由此OpenMBeanAttributeInfoSupport实例描述的属性的合法值的不可修改集合（如果指定），否则返回null。
      指定者:
      getLegalValues 在接口 OpenMBeanParameterInfo
      返回:
      合法值的集合。

    • getMinValue

      public Comparable<?> getMinValue()
      返回由此OpenMBeanAttributeInfoSupport实例描述的属性的最小值（如果指定），否则返回null。
      指定者:
      getMinValue 在接口 OpenMBeanParameterInfo
      返回:
      最小值。

    • getMaxValue

      public Comparable<?> getMaxValue()
      返回由此OpenMBeanAttributeInfoSupport实例描述的属性的最大值（如果指定），否则返回null。
      指定者:
      getMaxValue 在接口 OpenMBeanParameterInfo
      返回:
      最大值。

    • hasDefaultValue

      public boolean hasDefaultValue()
      如果此OpenMBeanAttributeInfoSupport实例为描述的属性指定了非null的默认值，则返回true，否则返回false。
      指定者:
      hasDefaultValue 在接口 OpenMBeanParameterInfo
      返回:
      如果存在默认值，则为true。

    • hasLegalValues

      public boolean hasLegalValues()
      如果此OpenMBeanAttributeInfoSupport实例为描述的属性指定了非null的合法值集合，则返回true，否则返回false。
      指定者:
      hasLegalValues 在接口 OpenMBeanParameterInfo
      返回:
      如果存在合法值集合，则为true。

    • hasMinValue

      public boolean hasMinValue()
      如果此OpenMBeanAttributeInfoSupport实例为描述的属性指定了非null的最小值，则返回true，否则返回false。
      指定者:
      hasMinValue 在接口 OpenMBeanParameterInfo
      返回:
      如果存在最小值，则为true。

    • hasMaxValue

      public boolean hasMaxValue()
      如果此OpenMBeanAttributeInfoSupport实例为描述的属性指定了非null的最大值，则返回true，否则返回false。
      指定者:
      hasMaxValue 在接口 OpenMBeanParameterInfo
      返回:
      如果存在最大值，则为true。

    • isValue

      public boolean isValue(Object obj)
      测试obj是否为此OpenMBeanAttributeInfoSupport实例描述的属性的有效值。
      指定者:
      isValue 在接口 OpenMBeanParameterInfo
      参数:
      obj - 要测试的对象。
      返回:
      如果obj是此OpenMBeanAttributeInfoSupport实例描述的参数的有效值，则为true，否则为false。

    • equals

      public boolean equals(Object obj)
      比较指定的obj参数与此OpenMBeanAttributeInfoSupport实例是否相等。

      仅当以下所有语句都为真时，返回true：

      • obj不为null，
      • obj也实现了OpenMBeanAttributeInfo接口，
      • 它们的名称相等，
      • 它们的开放类型相等，
      • 它们的访问属性（isReadable、isWritable和isIs）相等，
      • 它们的默认值、最小值、最大值和合法值相等。
      这确保了对于不同实现OpenMBeanAttributeInfo接口的obj参数，此equals方法能正常工作。

      如果obj还实现了DescriptorRead，则其getDescriptor()方法也必须返回与此对象相同的值。

      指定者：
      equals 在接口 OpenMBeanAttributeInfo
      指定者：
      equals 在接口 OpenMBeanParameterInfo
      覆盖：
      equals 在类 MBeanAttributeInfo
      参数：
      obj - 要与此OpenMBeanAttributeInfoSupport实例进行比较的对象。
      返回：
      如果指定的对象等于此OpenMBeanAttributeInfoSupport实例，则返回true。
      参见：

    • hashCode

      public int hashCode()

      返回此OpenMBeanAttributeInfoSupport实例的哈希码值。

      OpenMBeanAttributeInfoSupport实例的哈希码是用于equals比较的所有信息元素的哈希码之和（即：其名称、其开放类型、其默认值、最小值、最大值和合法值，以及其描述符）。

      这确保了对于任意两个OpenMBeanAttributeInfoSupport实例t1和t2，如果t1.equals(t2)，则t1.hashCode()==t2.hashCode()，符合方法Object.hashCode()的一般约定。

      但是，请注意，如果另一个实现OpenMBeanAttributeInfo接口的类的实例与此OpenMBeanAttributeInfoSupport实例相等（由equals(java.lang.Object)定义），但如果计算方式不同，则其哈希码可能不同。

      由于OpenMBeanAttributeInfoSupport实例是不可变的，因此此实例的哈希码在第一次调用hashCode时计算一次，然后对后续调用返回相同的值。

      指定者：
      hashCode 在接口 OpenMBeanAttributeInfo
      指定者：
      hashCode 在接口 OpenMBeanParameterInfo
      覆盖：
      hashCode 在类 Object
      返回：
      此OpenMBeanAttributeInfoSupport实例的哈希码值
      参见：

    • toString

      public String toString()
      返回此OpenMBeanAttributeInfoSupport实例的字符串表示形式。

      字符串表示形式包括此类的名称（即javax.management.openmbean.OpenMBeanAttributeInfoSupport）、所描述参数的名称和开放类型的字符串表示形式、其默认值、最小值、最大值和合法值的字符串表示形式以及其描述符的字符串表示形式。

      由于OpenMBeanAttributeInfoSupport实例是不可变的，因此此实例的字符串表示形式在第一次调用toString时计算一次，然后对后续调用返回相同的值。

      指定者：
      toString 在接口 OpenMBeanAttributeInfo
      指定者：
      toString 在接口 OpenMBeanParameterInfo
      覆盖：
      toString 在类 Object
      返回：
      此OpenMBeanAttributeInfoSupport实例的字符串表示形式。