JavaTM 2 Platform
Standard Ed. 6

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

這確保了此 equals 方法對作為 OpenMBeanParameterInfo 介面的不同實作的 obj 參數正常工作。
 

覆寫:
類別 Object 中的 equals
參數:
obj - 與 OpenMBeanParameterInfo 實例進行相等性比較的物件;
返回:
如果指定的物件等於此 OpenMBeanParameterInfo 實例,則返回 true
另請參見:
Object.hashCode(), Hashtable

hashCode

int hashCode()
返回此 OpenMBeanParameterInfo 實例的雜湊碼值。

OpenMBeanParameterInfo 實例的雜湊碼是在 equals 比較中使用的所有資訊元素的雜湊碼的總和(即其名稱、其開放型別 及其預設值、最小值、最大值和合法值)。

這確保 t1.equals(t2) 意味著對於任何兩個 OpenMBeanParameterInfo 實例 t1t2 而言,都存在 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 實例的字元串表示形式

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

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