Module java.management
Package javax.management.openmbean

Class OpenMBeanParameterInfoSupport

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanParameterInfo
javax.management.openmbean.OpenMBeanParameterInfoSupport
所有已实现的接口:
Serializable, Cloneable, DescriptorRead, OpenMBeanParameterInfo
public class OpenMBeanParameterInfoSupport extends MBeanParameterInfo implements OpenMBeanParameterInfo
描述了在一个或多个开放MBean的操作或构造函数中使用的参数。
自:
1.5
参见:

  • Field Summary

    Fields declared in class javax.management.MBeanFeatureInfo

    description, name

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)
    构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType和description。
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
    构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description和descriptor。
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)
    构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description和defaultValue。
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
    构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description、defaultValue、minValue和maxValue。
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)
    构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description、defaultValue和legalValues。

  • Method Summary

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

    Methods declared in class javax.management.MBeanParameterInfo

    clone, getType

    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.OpenMBeanParameterInfo

    getDescription, getName

  • Constructor Details

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)
      构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType和description。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
      构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description和descriptor。

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

      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      descriptor - 参数的描述符。这可能为null，相当于空描述符。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null，或描述符条目无效，如包描述中所述。
      自:
      1.6

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) throws OpenDataException
      构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description和defaultValue。
      类型参数:
      T - 允许编译器检查defaultValue（如果非null）是否具有给定openType的正确Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      defaultValue - 必须是此参数指定的openType的有效值；不支持ArrayType和TabularType的默认值；可以为null，此时表示未设置默认值。
      抛出:
      IllegalArgumentException - 如果name或description为null或空字符串，或openType为null。
      OpenDataException - 如果defaultValue不是指定的openType的有效值，或defaultValue非null且openType为ArrayType或TabularType。

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues) throws OpenDataException

      构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description、defaultValue和legalValues。

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

      类型参数:
      T - 允许编译器检查defaultValue和legalValues（如果非null）是否具有给定openType的正确Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      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中。

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
      构造一个OpenMBeanParameterInfoSupport实例，描述了一个或多个开放MBean类的操作或构造函数中使用的参数，具有指定的name、openType、description、defaultValue、minValue和maxValue。只能为值为Comparable的开放类型指定最小和最大值。
      类型参数:
      T - 允许编译器检查defaultValue、minValue和maxValue是否为正确的Java类型，如果非空，则必须符合给定openType的Java类型。
      参数:
      name - 不能为空或空字符串。
      description - 不能为空或空字符串。
      openType - 不能为空。
      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()
      返回由此OpenMBeanParameterInfoSupport实例描述的参数的值的开放类型。
      指定者:
      getOpenType 在接口 OpenMBeanParameterInfo
      返回:
      开放类型。

    • getDefaultValue

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

    • getLegalValues

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

    • getMinValue

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

    • getMaxValue

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

    • hasDefaultValue

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

    • hasLegalValues

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

    • hasMinValue

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

    • hasMaxValue

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

    • isValue

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

    • equals

      public boolean equals(Object obj)

      将指定的obj参数与此OpenMBeanParameterInfoSupport实例进行比较以确定是否相等。

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

      • obj非null，
      • obj还实现了OpenMBeanParameterInfo接口，
      • 它们的名称相等，
      • 它们的开放类型相等，
      • 它们的默认值、最小值、最大值和合法值相等。
      这确保了对于不同实现OpenMBeanParameterInfo接口的obj参数，此equals方法能正常工作。

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

      指定者:
      equals 在接口 OpenMBeanParameterInfo
      覆盖:
      equals 在类 MBeanParameterInfo
      参数:
      obj - 要与此OpenMBeanParameterInfoSupport实例比较是否相等的对象。
      返回:
      如果指定的对象等于此OpenMBeanParameterInfoSupport实例，则返回true。
      参见:

    • hashCode

      public int hashCode()

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

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

      这确保了对于任何两个OpenMBeanParameterInfoSupport实例t1和t2，如果t1.equals(t2)，则t1.hashCode()==t2.hashCode()，这是Object.hashCode()方法的一般契约要求。

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

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

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

    • toString

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

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

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

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