模块 java.management
包 javax.management.openmbean

类 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
参见：

  • 字段摘要

    在类 javax.management.MBeanFeatureInfo 中声明的字段

    description, name

  • 构造方法总结

    构造方法
    构造方法
    描述
    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 。

  • 方法总结

    修饰符和类型
    方法
    描述
    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 实例的字符串表示形式。

    在类 javax.management.MBeanParameterInfo 中声明的方法

    clone, getType

    在类 javax.management.MBeanFeatureInfo 中声明的方法

    getDescription, getDescriptor, getName

    在类 java.lang.Object 中声明的方法

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

    在接口 javax.management.openmbean.OpenMBeanParameterInfo 中声明的方法

    getDescription, getName

  • 构造方法详细信息

    • OpenMBeanParameterInfoSupport

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

    • OpenMBeanParameterInfoSupport

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

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

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

    • OpenMBeanParameterInfoSupport

      public OpenMBeanParameterInfoSupport(String  name, String  description, OpenType <T> openType, T defaultValue) throws OpenDataException
      构造一个 OpenMBeanParameterInfoSupport 实例，它描述了一个或多个操作或一类开放 MBean 的构造函数中使用的参数，具有指定的 name 、 openType 、 description 和 defaultValue 。
      类型参数：
      T - 允许编译器检查 defaultValue（如果非空）是否具有给定 openType 的正确 Java 类型。
      参数：
      name - 不能为 null 或空字符串。
      description - 不能为 null 或空字符串。
      openType - 不能为空。
      defaultValue - 必须是为此参数指定的 openType 的有效值； ArrayType 和 TabularType 不支持默认值；可以为空，在这种情况下它意味着没有设置默认值。
      抛出：
      IllegalArgumentException - 如果 name 或 description 为空或空字符串，或者 openType 为空。
      OpenDataException - 如果 defaultValue 不是指定 openType 的有效值，或者 defaultValue 非空且 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（如果非空）是否具有给定 openType 的正确 Java 类型。
      参数：
      name - 不能为 null 或空字符串。
      description - 不能为 null 或空字符串。
      openType - 不能为空。
      defaultValue - 必须是为此参数指定的 openType 的有效值； ArrayType 和 TabularType 不支持默认值；可以为空，在这种情况下它意味着没有设置默认值。
      legalValues - 每个包含的值必须对该参数指定的 openType 有效； ArrayType 和 TabularType 不支持合法值；可以为 null 或为空。
      抛出：
      IllegalArgumentException - 如果 name 或 description 为空或空字符串，或者 openType 为空。
      OpenDataException - 如果 defaultValue 不是指定的 openType 的有效值，或者 legalValues 中的一个值对指定的 openType 无效，或者 defaultValue 不为空且 openType 是 ArrayType 或 TabularType 或 legalValues 非空且非空并且 openType 是一个 ArrayType 或一个 TabularType，或者 legalValues 是非空且非空的， 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（如果不为空）是否具有给定 openType 的正确 Java 类型。
      参数：
      name - 不能为 null 或空字符串。
      description - 不能为 null 或空字符串。
      openType - 不能为空。
      defaultValue - 必须是为此参数指定的 openType 的有效值； ArrayType 和 TabularType 不支持默认值；可以为空，在这种情况下它意味着没有设置默认值。
      minValue - 必须对为此参数指定的 openType 有效；可以为空，在这种情况下它意味着没有设置最小值。
      maxValue - 必须对为此参数指定的 openType 有效；可以为空，在这种情况下意味着没有设置最大值。
      抛出：
      IllegalArgumentException - 如果 name 或 description 为空或空字符串，或者 openType 为空。
      OpenDataException - 如果 defaultValue 、 minValue 或 maxValue 不是指定 openType 的有效值，或者 defaultValue 非空且 openType 是 ArrayType 或 TabularType ，或两者都是 minValue 和 maxValue 是非空的并且 minValue.compareTo(maxValue) > 0 是 true ，或者 defaultValue 和minValue 是非空的并且 minValue.compareTo(defaultValue) > 0 是 true ，或者 defaultValue 和 maxValue 都是非空的并且 defaultValue.compareTo(maxValue) > 0 是 true 。

  • 方法详情

    • 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 实例为所述参数指定非空默认值，则返回 true，否则返回 false。
      指定者：
      hasDefaultValue 在接口 OpenMBeanParameterInfo 中
      返回：
      如果有默认值，则为真。

    • hasLegalValues

      public boolean hasLegalValues()
      如果此 OpenMBeanParameterInfoSupport 实例为所述参数指定一组非空合法值，则返回 true，否则返回 false。
      指定者：
      hasLegalValues 在接口 OpenMBeanParameterInfo 中
      返回：
      如果存在一组合法值，则为真。

    • hasMinValue

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

    • hasMaxValue

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

    • isValue

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

    • equals

      public boolean equals(Object  obj)

      比较指定的 obj 参数与此 OpenMBeanParameterInfoSupport 实例是否相等。

      当且仅当以下所有陈述都为真时，返回 true：

      • obj 非空，
      • obj 还实现了 OpenMBeanParameterInfo 接口，
      • 他们的名字是平等的
      • 它们的开放类型是相等的
      • 它们的默认值、最小值、最大值和合法值是相等的。
      这确保此 equals 方法适用于 obj 参数，这些参数是 OpenMBeanParameterInfo 接口的不同实现。

      如果 obj 也实现了 DescriptorRead ，那么它的 getDescriptor() 方法也必须返回与该对象相同的值。

      指定者：
      equals 在接口 OpenMBeanParameterInfo 中
      重写：
      equals 在类 MBeanParameterInfo 中
      参数：
      obj - 要与此 OpenMBeanParameterInfoSupport 实例进行相等比较的对象。
      返回：
      true 如果指定对象等于此 OpenMBeanParameterInfoSupport 实例。
      参见：

    • hashCode

      public int hashCode()

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

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

      这确保 t1.equals(t2) 暗示 t1.hashCode()==t2.hashCode() 对于任何两个 OpenMBeanParameterInfoSupport 实例 t1 和 t2，正如方法 Object.hashCode() 的一般契约所要求的那样。

      但是，请注意，实现 OpenMBeanParameterInfo 接口的类的另一个实例可能等于 equals(java.lang.Object) 定义的这个 OpenMBeanParameterInfoSupport 实例，但如果计算方式不同，则可能具有不同的哈希码。

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

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

    • toString

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

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

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

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