JavaTM 2 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 實例,該實例使用指定的 nameopenTypedescription 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
          建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondescriptor 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)
          建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValue 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
          建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValueminValuemaxValue 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)
          建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValuelegalValues 來描述一個或多個操作或 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 實例,該實例使用指定的 nameopenTypedescription 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。

參數:
name - 不可為 null 或空字元串。
description - 不可為 null 或空字元串。
openType - 不可為 null。
拋出:
IllegalArgumentException - 如果 namedescription 為 null 或空字元串,或者 openType 為 null。

OpenMBeanParameterInfoSupport

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

建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondescriptor 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。

正如包描述中所解釋的那樣,descriptor 可以包含將定義此類別某些方法返回值的項。

參數:
name - 不可為 null 或空字元串。
description - 不可為 null 或空字元串。
openType - 不可為 null。
descriptor - 參數的描述符。此參數可以為 null,其等效於一個空描述符。
拋出:
IllegalArgumentException - 如果 namedescription 為 null 或空字元串;或者 openType 為 null;或者根據包描述中的描述,描述符項無效。
從以下版本開始:
1.6

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<T> openType,
                                     T defaultValue)
                              throws OpenDataException
建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValue 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。

型別參數:
T - 允許編譯器查看 defaultValue(如果不為 null)是否具有對應 openType 的正確 Java 型別。
參數:
name - 不可為 null 或空字元串。
description - 不可為 null 或空字元串。
openType - 不可為 null。
defaultValue - 必須是為此參數指定的 openType 的有效值;預設值不支持 ArrayTypeTabularType;可以為 null,在這種情況下,它意味著不設置任何預設值。
拋出:
IllegalArgumentException - 如果 namedescription 為 null 或空字元串,或者 openType 為 null。
OpenDataException - 如果 defaultValue 不是指定 openType 的有效值,或者 defaultValue 不為 null 且 openTypeArrayTypeTabularType

OpenMBeanParameterInfoSupport

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

建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValuelegalValues 來描述一個或多個操作或 open MBean 類別的建構子所使用的參數。

複製 legalValues 的內容,因此對 legalValues 參考的陣列進行後續修改不會影響此 OpenMBeanParameterInfoSupport 實例。

型別參數:
T - 允許編譯器查看 defaultValuelegalValues(如果不為 null)是否具有對應 openType 的正確 Java 型別。
參數:
name - 不可為 null 或空字元串。
description - 不可為 null 或空字元串。
openType - 不可為 null。
defaultValue - 必須是為此參數指定的 openType 的有效值;預設值不支持 ArrayTypeTabularType;可以為 null,在這種情況下,它意味著不設置任何預設值。
legalValues - 套件含的每個值對於為此參數指定的 openType 必須是有效的;ArrayTypeTabularType 不支持的合法值;可以為 null 或空。
拋出:
IllegalArgumentException - 如果 namedescription 為 null 或空字元串,或者 openType 為 null。
OpenDataException - 如果 defaultValue 對指定的 openType 無效;如果 legalValues 中的一個值對指定的 openType 無效;如果 defaultValue 為非 null 且 openTypeArrayTypeTabularType;如果 legalValues 為非 null 和非空(null)且 openTypeArrayTypeTabularType;如果 legalValues 為非 null 和非空(null)且 legalValues 中不包含 defaultValue

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<T> openType,
                                     T defaultValue,
                                     Comparable<T> minValue,
                                     Comparable<T> maxValue)
                              throws OpenDataException
建構一個 OpenMBeanParameterInfoSupport 實例,該實例使用指定的 nameopenTypedescriptiondefaultValueminValuemaxValue 描述用於 open MBeans 的類別的一個或多個操作或建構子的參數。只有值是 Comparable 的開放型別才能指定最小值和最大值。

型別參數:
T - 允許編譯器查看 defaultValueminValuemaxValue(如果不為 null)是否具有對應 openType 的正確 Java 型別。
參數:
name - 不可為 null 或空字元串。
description - 不可為 null 或空字元串。
openType - 不可為 null。
defaultValue - 必須是為此參數指定的 openType 的有效值;預設值不支持 ArrayTypeTabularType;可以為 null,在這種情況下,它意味著不設置任何預設值。
minValue - 必須對為此參數指定的 openType 有效;可以為 null,在這種情況下,它意味著不設置任何最小值。
maxValue - 必須對為此參數指定的 openType 有效;可以為 null,在這種情況下,它意味著不設置任何最大值。
拋出:
IllegalArgumentException - 如果 namedescription 為 null 或空字元串,或者 openType 為 null。
OpenDataException - 如果 defaultValueminValuemaxValue 不是對應指定 openType 的有效值;如果 defaultValue 不為 null 且 openTypeArrayTypeTabularType;如果 minValuemaxValue 都不為 null 且 minValue.compareTo(maxValue) > 0true;如果 defaultValueminValue 都不為 null 且 minValue.compareTo(defaultValue) > 0true;如果 defaultValuemaxValue 都不為 null 且 defaultValue.compareTo(maxValue) > 0true
方法詳細資訊

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

這確保了此 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 實例 t1t2 而言,都存在 @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 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only