模块 java.management

软件包 javax.management.openmbean

Class 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

另请参见：

Serialized Form

字段汇总

声明的属性在类 javax.management.MBeanFeatureInfo

description, name

构造方法摘要

构造方法

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

方法摘要

变量和类型	方法	描述
boolean	equals(Object obj)	将指定的 obj参数与此 OpenMBeanParameterInfoSupport实例进行比较以获得相等性。
Object	getDefaultValue()	如果指定，则返回此 OpenMBeanParameterInfoSupport实例描述的参数的默认值，否则 null 。
Set<?>	getLegalValues()	如果指定，则返回此 OpenMBeanParameterInfoSupport实例描述的参数的不可修改的合法值集，否则 null 。
Comparable<?>	getMaxValue()	返回此 OpenMBeanParameterInfoSupport实例描述的参数的最大值（如果已指定），否则 null 。
Comparable<?>	getMinValue()	返回此 OpenMBeanParameterInfoSupport实例描述的参数的 OpenMBeanParameterInfoSupport （如果已指定），否则 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实例的字符串表示形式。

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

参数

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

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

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 - 不能为空或空字符串。

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

openType - 不能为空。

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

异常

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 （如果为非null）具有给定 openType的正确Java类型。

参数

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

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

openType - 不能为空。

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

异常

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

复制了legalValues的内容，因此legalValues引用的数组的后续修改对此OpenMBeanParameterInfoSupport实例没有影响。

参数类型

T - 允许编译器检查 defaultValue和 legalValues （如果为非null）具有给定 openType的正确Java类型。

参数

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

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

openType - 不能为空。

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

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

异常

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 - 不能为空或空字符串。

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

openType - 不能为空。

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

minValue - 必须对为此参数指定的openType有效; 可以为null，在这种情况下，它表示没有设置最小值。

maxValue - 必须对为此参数指定的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为非null且 minValue.compareTo(defaultValue) > 0为 true ，或者 defaultValue和 maxValue均为非null且 defaultValue.compareTo(maxValue) > 0为 true 。

方法详细信息

getOpenType

public OpenType<?> getOpenType()

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

Specified by:

getOpenType在界面 OpenMBeanParameterInfo

结果

开放式。

getDefaultValue

public Object getDefaultValue()

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

Specified by:

getDefaultValue在界面 OpenMBeanParameterInfo

结果

默认值。

getLegalValues

public Set<?> getLegalValues()

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

Specified by:

getLegalValues接口 OpenMBeanParameterInfo

结果

一套合法的价值观。

getMinValue

public Comparable<?> getMinValue()

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

Specified by:

getMinValue接口 OpenMBeanParameterInfo

结果

最小值。

getMaxValue

public Comparable<?> getMaxValue()

如果指定，则返回此 OpenMBeanParameterInfoSupport实例描述的参数的最大值，否则 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

结果

如果有一组合法值，则为true。

hasMinValue

public boolean hasMinValue()

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

Specified by:

hasMinValue接口 OpenMBeanParameterInfo

结果

如果有最小值，则为true。

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实例描述的参数的 OpenMBeanParameterInfo ， false 。

equals

public boolean equals(Object obj)

将指定的obj参数与此OpenMBeanParameterInfoSupport实例进行比较以获得相等性。

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

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

这可确保此equals方法适用于obj参数，这些参数是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例如通过定义equals(java.lang.Object) ，但是如果它的计算方法不同可具有不同的哈希码。

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

Specified by:

hashCode接口 OpenMBeanParameterInfo

重写：

hashCode在类 Object

结果

此 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在类 Object

结果

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