javax.management.openmbean
接口 OpenMBeanParameterInfo

所有已知子接口：

OpenMBeanAttributeInfo

所有已知实现类：

OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport

public interface OpenMBeanParameterInfo

描述用于 open MBean 的一个或多个操作或构造方法的参数。

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

从以下版本开始：

1.5

方法摘要

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 实例的字符串表示形式。

方法详细信息

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 时，才返回 true：

• obj 为非 null；
• obj 还实现 OpenMBeanParameterInfo 接口；
• 它们的名称相等；
• 它们的开放类型相等；
• 它们的默认值、最小值、最大值和合法值相等。

这确保了此 equals 方法对作为 OpenMBeanParameterInfo 接口的不同实现的 obj 参数正常工作。

覆盖：

类 Object 中的 equals

参数：

obj - 与 OpenMBeanParameterInfo 实例进行相等性比较的对象；

返回：

如果指定的对象等于此 OpenMBeanParameterInfo 实例，则返回 true。

另请参见：

Object.hashCode(), Hashtable

hashCode

int hashCode()

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

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

这确保 t1.equals(t2) 意味着对于任何两个 OpenMBeanParameterInfo 实例 t1 和 t2 而言，都存在 t1.hashCode()==t2.hashCode()，这是方法 Object.hashCode() 的通用协定所要求的。

覆盖：

类 Object 中的 hashCode

返回：

此 OpenMBeanParameterInfo 实例的哈希码值

另请参见：

Object.equals(java.lang.Object), Hashtable

toString

String toString()

返回此 OpenMBeanParameterInfo 实例的字符串表示形式。

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

覆盖：

类 Object 中的 toString

返回：

此 OpenMBeanParameterInfo 实例的字符串表示形式