当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

OpenMBeanParameterInfoSupport (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

---

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM Platform Standard Ed. 6
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

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

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

从以下版本开始：

1.5

另请参见：

序列化表格

---

字段摘要

 

从类 javax.management.MBeanFeatureInfo 继承的字段
description, name

 

构造方法摘要
OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)           构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType 和 description 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)           构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description 和 descriptor 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)           构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description 和 defaultValue 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)           构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description、defaultValue、minValue 和 maxValue 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)           构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description、defaultValue 和 legalValues 来描述一个或多个操作或 open MBean 类的构造方法所使用的参数。

 

方法摘要
boolean	equals(Object obj)           比较指定的 obj 参数与此 OpenMBeanParameterInfoSupport 实例的相等性。
Object	getDefaultValue()           返回此 OpenMBeanParameterInfoSupport 实例描述的参数的默认值（如果指定），否则返回 null。
Set<?>	getLegalValues()           返回此 OpenMBeanParameterInfoSupport 实例描述的合法参数值的不可修改的 Set（如果指定），否则返回 null。
Comparable<?>	getMaxValue()           返回此 OpenMBeanParameterInfoSupport 实例描述的参数的最大值（如果指定），否则返回 null。
Comparable<?>	getMinValue()           返回此 OpenMBeanParameterInfoSupport 实例描述的参数的最小值（如果指定），否则返回 null。
OpenType<?>	getOpenType()           返回此 OpenMBeanParameterInfoSupport 实例描述的参数值的开放类型。
boolean	hasDefaultValue()           如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的默认值，则返回 true，否则返回 false。
int	hashCode()           返回此 OpenMBeanParameterInfoSupport 实例的哈希码值。
boolean	hasLegalValues()           如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的合法值集，则返回 true，否则返回 false。
boolean	hasMaxValue()           如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的最大值，则返回 true，否则返回 false。
boolean	hasMinValue()           如果此 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的最小值，则返回 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 实例，该实例使用指定的 name、openType 和 description 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。

参数：

name - 不可为 null 或空字符串。

description - 不可为 null 或空字符串。

openType - 不可为 null。

抛出：

IllegalArgumentException - 如果 name 或 description 为 null 或空字符串，或者 openType 为 null。

---

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<?> openType,
                                     Descriptor descriptor)

构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description 和 descriptor 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。

正如包描述中所解释的那样，descriptor 可以包含将定义此类某些方法返回值的项。

参数：

name - 不可为 null 或空字符串。

description - 不可为 null 或空字符串。

openType - 不可为 null。

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 实例，该实例使用指定的 name、openType、description 和 defaultValue 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。

类型参数：

T - 允许编译器查看 defaultValue（如果不为 null）是否具有对应 openType 的正确 Java 类型。

参数：

name - 不可为 null 或空字符串。

description - 不可为 null 或空字符串。

openType - 不可为 null。

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 实例，该实例使用指定的 name、openType、description、defaultValue 和 legalValues 来描述一个或多个操作或 open MBean 类的构造方法所使用的参数。

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

类型参数：

T - 允许编译器查看 defaultValue 和 legalValues（如果不为 null）是否具有对应 openType 的正确 Java 类型。

参数：

name - 不可为 null 或空字符串。

description - 不可为 null 或空字符串。

openType - 不可为 null。

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 和非空且 legalValues 中不包含 defaultValue。

---

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<T> openType,
                                     T defaultValue,
                                     Comparable<T> minValue,
                                     Comparable<T> maxValue)
                              throws OpenDataException

构造一个 OpenMBeanParameterInfoSupport 实例，该实例使用指定的 name、openType、description、defaultValue、minValue 和 maxValue 描述用于 open MBeans 的类的一个或多个操作或构造方法的参数。只有值是 Comparable 的开放类型才能指定最小值和最大值。

类型参数：

T - 允许编译器查看 defaultValue、minValue 和 maxValue（如果不为 null）是否具有对应 openType 的正确 Java 类型。

参数：

name - 不可为 null 或空字符串。

description - 不可为 null 或空字符串。

openType - 不可为 null。

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。

方法详细信息

getOpenType

public OpenType<?> getOpenType()

返回此 OpenMBeanParameterInfoSupport 实例描述的参数值的开放类型。

指定者：

接口 OpenMBeanParameterInfo 中的 getOpenType

返回：

开放类型。

---

getDefaultValue

public Object getDefaultValue()

返回此 OpenMBeanParameterInfoSupport 实例描述的参数的默认值（如果指定），否则返回 null。

指定者：

接口 OpenMBeanParameterInfo 中的 getDefaultValue

返回：

默认值。

---

getLegalValues

public Set<?> getLegalValues()

返回此 OpenMBeanParameterInfoSupport 实例描述的合法参数值的不可修改的 Set（如果指定），否则返回 null。

指定者：

接口 OpenMBeanParameterInfo 中的 getLegalValues

返回：

合法值的集合。

---

getMinValue

public Comparable<?> getMinValue()

返回此 OpenMBeanParameterInfoSupport 实例描述的参数的最小值（如果指定），否则返回 null。

指定者：

接口 OpenMBeanParameterInfo 中的 getMinValue

返回：

最小值。

---

getMaxValue

public Comparable<?> getMaxValue()

返回此 OpenMBeanParameterInfoSupport 实例描述的参数的最大值（如果指定），否则返回 null。

指定者：

接口 OpenMBeanParameterInfo 中的 getMaxValue

返回：

最大值。

---

hasDefaultValue

public boolean hasDefaultValue()

如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的默认值，则返回 true，否则返回 false。

指定者：

接口 OpenMBeanParameterInfo 中的 hasDefaultValue

返回：

如果存在默认值，则返回 true。

---

hasLegalValues

public boolean hasLegalValues()

如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的合法值集，则返回 true，否则返回 false。

指定者：

接口 OpenMBeanParameterInfo 中的 hasLegalValues

返回：

如果存在合法值的集合，则返回 true。

---

hasMinValue

public boolean hasMinValue()

如果此 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的最小值，则返回 true，否则返回 false。

指定者：

接口 OpenMBeanParameterInfo 中的 hasMinValue

返回：

如果存在最小值，则返回 true。

---

hasMaxValue

public boolean hasMaxValue()

如果 OpenMBeanParameterInfoSupport 实例指定所描述参数的非 null 的最大值，则返回 true，否则返回 false。

指定者：

接口 OpenMBeanParameterInfo 中的 hasMaxValue

返回：

如果存在最大值，则返回 true。

---

isValue

public boolean isValue(Object obj)

测试 obj 是否为此 OpenMBeanParameterInfo 实例描述的参数的有效值。

指定者：

接口 OpenMBeanParameterInfo 中的 isValue

参数：

obj - 要测试的对象。

返回：

如果 obj 是此 OpenMBeanParameterInfo 实例描述的参数的有效值，则返回 true，否则返回 false。

---

equals

public boolean equals(Object obj)

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

当且仅当下面的所有语句均为 true 时，才返回 true：

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

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

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

指定者：

接口 OpenMBeanParameterInfo 中的 equals

覆盖：

类 MBeanParameterInfo 中的 equals

参数：

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

返回：

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

另请参见：

Object.hashCode(), Hashtable

---

hashCode

public int hashCode()

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

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

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

不过请注意，根据 equals(java.lang.Object) 中的定义，实现 OpenMBeanParameterInfo 接口的类的其他实例可能与此 OpenMBeanParameterInfoSupport 实例相等，但是如果它的计算方法不同，可能会有不同的哈希码。

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

指定者：

接口 OpenMBeanParameterInfo 中的 hashCode

覆盖：

类 MBeanParameterInfo 中的 hashCode

返回：

此 OpenMBeanParameterInfoSupport 实例的哈希码值

另请参见：

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

---

toString

public String toString()

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

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

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

指定者：

接口 OpenMBeanParameterInfo 中的 toString

覆盖：

类 MBeanParameterInfo 中的 toString

返回：

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

---

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM Platform Standard Ed. 6
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。