Module java.management
Package javax.management.openmbean

Interface OpenMBeanParameterInfo

所有已知的子接口:
OpenMBeanAttributeInfo
所有已知的实现类:
OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport
public interface OpenMBeanParameterInfo

描述了在一个或多个开放MBean的操作或构造函数中使用的参数。

该接口声明了与类MBeanParameterInfo相同的方法。实现此接口的类（通常是OpenMBeanParameterInfoSupport）应该扩展MBeanParameterInfo。

自Java版本:
1.5

  • Method Summary

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

  • Method Details

    • getDescription

      String getDescription()
      返回描述此OpenMBeanParameterInfo实例的参数的人类可读描述。
      返回:
      描述。

    • getName

      String getName()
      返回描述此OpenMBeanParameterInfo实例的参数的名称。
      返回:
      名称。

    • getOpenType

      OpenType<?> getOpenType()
      返回此OpenMBeanParameterInfo实例描述的参数值的开放类型。
      返回:
      开放类型。

    • getDefaultValue

      Object getDefaultValue()
      返回此参数的默认值（如果有），否则返回null。
      返回:
      默认值。

    • getLegalValues

      Set<?> getLegalValues()
      返回此参数的合法值集（如果有），否则返回null。
      返回:
      合法值集。

    • getMinValue

      Comparable<?> getMinValue()
      返回此参数的最小值（如果有），否则返回null。
      返回:
      最小值。

    • getMaxValue

      Comparable<?> getMaxValue()
      返回此参数的最大值（如果有），否则返回null。
      返回:
      最大值。

    • hasDefaultValue

      boolean hasDefaultValue()
      如果此参数具有指定的默认值，则返回true，否则返回false。
      返回:
      如果有默认值则为true。

    • hasLegalValues

      boolean hasLegalValues()
      如果此参数具有指定的合法值集，则返回true，否则返回false。
      返回:
      如果有合法值集则为true。

    • hasMinValue

      boolean hasMinValue()
      如果此参数具有指定的最小值，则返回true，否则返回false。
      返回:
      如果有最小值则为true。

    • hasMaxValue

      boolean hasMaxValue()
      如果此参数具有指定的最大值，则返回true，否则返回false。
      返回:
      如果有最大值则为true。

    • isValue

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

    • equals

      boolean equals(Object obj)
      将指定的obj参数与此OpenMBeanParameterInfo实例进行比较，以确定它们是否相等。

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

      • obj非空，
      • obj还实现了OpenMBeanParameterInfo接口，
      • 它们的名称相等，
      • 它们的开放类型相等，
      • 它们的默认值、最小值、最大值和合法值相等。
      这确保了对于不同实现OpenMBeanParameterInfo接口的obj参数，此equals方法能够正常工作。
       
      覆盖:
      equals 在类 Object中
      参数:
      obj - 与此OpenMBeanParameterInfo实例比较是否相等的对象;
      返回:
      如果指定的对象等于此OpenMBeanParameterInfo实例，则返回true。
      参见:

    • hashCode

      int hashCode()
      返回此OpenMBeanParameterInfo实例的哈希码值。

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

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

      覆盖:
      hashCode 在类 Object中
      返回:
      此OpenMBeanParameterInfo实例的哈希码值
      参见:

    • toString

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

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

      覆盖:
      toString 在类 Object中
      返回:
      此OpenMBeanParameterInfo实例的字符串表示形式