compact3

javax.management.openmbean

Class OpenMBeanParameterInfoSupport

java.lang.Object

javax.management.MBeanFeatureInfo

javax.management.MBeanParameterInfo

javax.management.openmbean.OpenMBeanParameterInfoSupport

All Implemented Interfaces:

Serializable ， Cloneable ， DescriptorRead ， OpenMBeanParameterInfo

public class OpenMBeanParameterInfoSupport
extends MBeanParameterInfo
implements OpenMBeanParameterInfo

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

从以下版本开始：

1.5

另请参见：

Serialized Form

Field Summary

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

构造方法摘要

构造方法

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

方法摘要

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

Methods inherited from class javax.management.MBeanParameterInfo

clone, getType

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getDescriptor, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.management.openmbean.OpenMBeanParameterInfo

getDescription, getName

构造方法详细信息

OpenMBeanParameterInfoSupport

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

构造一个 OpenMBeanParameterInfoSupport实例，该实例描述了在一个或多个操作或open 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实例，该实例描述了在一个或多个操作或open MBean类的构造函数中使用的参数，具有指定name ， openType ， description和descriptor 。

所述descriptor可以包含将定义由这个类的某些方法返回的值，如在解释条目package description 。

参数

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

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

openType - 不能为空。

descriptor - 参数的描述符。 这可能是空的，这相当于空描述符。

异常

IllegalArgumentException -如果 name或 description是空值或空字符串，或 openType为空，或如所描述的描述符条目是无效的 package description 。

从以下版本开始：

1.6

OpenMBeanParameterInfoSupport

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

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

参数类型

T - 允许编译器检查 defaultValue ，如果非空，则具有给定的 openType的正确Java类型。

参数

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

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

openType - 不能为空。

defaultValue -必须是一个有效的值openType为此参数指定; ArrayType和TabularType不支持默认值; 可以为null，在这种情况下，这意味着没有设置默认值。

异常

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

OpenDataException - 如果 defaultValue不是指定的openType的 openType ，或 defaultValue是非空值，并且 openType是 ArrayType或 TabularType 。

OpenMBeanParameterInfoSupport

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

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

legalValues的内容被复制，所以legalValues引用的数组的后续legalValues对这个OpenMBeanParameterInfoSupport实例没有影响。

参数类型

T - 允许编译器检查 defaultValue和 legalValues ，如果非空，则给出给定的 openType的正确Java类型。

参数

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

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

openType - 不能为空。

defaultValue -必须是一个有效的值openType为此参数指定; ArrayType和TabularType不支持默认值; 可以为null，在这种情况下，这意味着没有设置默认值。

legalValues -每个包含值必须是有效的openType为此参数指定; ArrayType和TabularType不支持合法值; 可以为空或为空。

异常

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

OpenDataException -如果 defaultValue是不是指定的有效值 openType ，或在一个值 legalValues无效指定 openType ，或 defaultValue为非null和 openType是 ArrayType或 TabularType ，或 legalValues为非null和非空和 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实例，该实例描述了在一个或多个操作或open MBean类的构造函数中使用的参数，具有指定name ， openType ， description ， defaultValue ， minValue和maxValue 。 可以仅为值为Comparable的打开类型指定最小值和最大值。

参数类型

T -允许编译器检查 defaultValue ， minValue和 maxValue ，如果非空，对给定正确的Java类型 openType 。

参数

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

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

openType - 不能为空。

defaultValue -必须是一个有效的值openType为此参数指定; ArrayType和TabularType不支持默认值; 可以为null，在这种情况下，这意味着没有设置默认值。

minValue - 对于此参数openType openType必须有效; 可以为null，在这种情况下，这意味着没有设置最小值。

maxValue - 必须对该openType指定的openType有效; 可以为null，在这种情况下，这意味着没有设置最大值。

异常

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

OpenDataException -如果 defaultValue ， minValue或 maxValue是不是指定的有效值 openType ，或 defaultValue为非null和 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实例描述的参数的值的打开类型。

Specified by:

getOpenType在接口 OpenMBeanParameterInfo

结果

开放式。

getDefaultValue

public Object getDefaultValue()

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

Specified by:

getDefaultValue在接口 OpenMBeanParameterInfo

结果

默认值。

getLegalValues

public Set<?> getLegalValues()

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

Specified by:

getLegalValues在接口 OpenMBeanParameterInfo

结果

一套法定价值观。

getMinValue

public Comparable<?> getMinValue()

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

Specified by:

getMinValue在接口 OpenMBeanParameterInfo

结果

最小值。

getMaxValue

public Comparable<?> getMaxValue()

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

Specified by:

getMaxValue在接口 OpenMBeanParameterInfo

结果

最大值。

hasDefaultValue

public boolean hasDefaultValue()

返回 true如果 OpenMBeanParameterInfoSupport实例指定所描述参数，一个非空默认值 false其他。

Specified by:

hasDefaultValue在接口 OpenMBeanParameterInfo

结果

如果有默认值，则为true。

hasLegalValues

public boolean hasLegalValues()

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

Specified by:

hasLegalValues在接口 OpenMBeanParameterInfo

结果

如果有一套合法的价值观，就是真实的。

hasMinValue

public boolean hasMinValue()

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

Specified by:

hasMinValue在接口 OpenMBeanParameterInfo

结果

如果有最小值，则为真。

hasMaxValue

public boolean hasMaxValue()

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

Specified by:

hasMaxValue在接口 OpenMBeanParameterInfo

结果

如果有最大值，则为true。

isValue

public boolean isValue(Object obj)

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

Specified by:

isValue在接口 OpenMBeanParameterInfo

参数

obj - 要测试的对象。

结果

true如果 obj是由此 OpenMBeanParameterInfo实例 false参数的有效值， false false。

equals

public boolean equals(Object obj)

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

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

• obj为非空，
• obj还实现了OpenMBeanParameterInfo接口，
• 他们的名字是平等的
• 他们的公开类型是平等的
• 其默认值，最小值，最大值和合法值相等。

这可以确保equals方法适用于obj参数，这些参数是OpenMBeanParameterInfo接口的OpenMBeanParameterInfo实现。

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

Specified by:

equals在接口 OpenMBeanParameterInfo

重写：

equals在 MBeanParameterInfo

参数

obj - 要与此 OpenMBeanParameterInfoSupport实例相等的对象。

结果

true如果指定的对象等于这个 OpenMBeanParameterInfoSupport实例。

另请参见：

Object.hashCode() ， HashMap

hashCode

public int hashCode()

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

一个的哈希码OpenMBeanParameterInfoSupport实例中使用的所有信息元素的哈希码的总和equals比较（即：其名称， 敞开式 ，它的默认值，最小值，最大值和合法值，并且它的描述符）。

这确保了t1.equals(t2)意味着t1.hashCode()==t2.hashCode()对于任何两个OpenMBeanParameterInfoSupport实例t1和t2 ，根据方法Object.hashCode()的一般合同的要求 。

但是，请注意，实现OpenMBeanParameterInfo接口的类的另一个实例可能与OpenMBeanParameterInfoSupport定义的这个OpenMBeanParameterInfoSupport实例相同 ，但是如果不同的计算方式可能具有不同的哈希码。

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

Specified by:

hashCode在接口 OpenMBeanParameterInfo

重写：

hashCode在 MBeanParameterInfo

结果

这个 OpenMBeanParameterInfoSupport实例的哈希码值

另请参见：

Object.equals(java.lang.Object) ， System.identityHashCode(java.lang.Object)

toString

public String toString()

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

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

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

Specified by:

toString在界面 OpenMBeanParameterInfo

重写：

toString在 MBeanParameterInfo

结果

这个 OpenMBeanParameterInfoSupport实例的字符串表示形式。