javax.management.openmbean
クラス CompositeType

java.lang.Object
  javax.management.openmbean.OpenType<CompositeData>
      javax.management.openmbean.CompositeType

すべての実装されたインタフェース:

Serializable

public class CompositeType
extends OpenType<CompositeData>

CompositeType クラスは、CompositeData 値の型を記述するインスタンスを持つ「公開型」クラスです。

導入されたバージョン:

1.5

関連項目:

直列化された形式

フィールドの概要

クラス javax.management.openmbean.OpenType から継承されたフィールド

ALLOWED_CLASSNAMES, ALLOWED_CLASSNAMES_LIST

コンストラクタの概要

CompositeType(String typeName, String description, String[] itemNames, String[] itemDescriptions, OpenType<?>[] itemTypes)
CompositeType インスタンスを構築し、指定されたパラメータの妥当性を検査します。

メソッドの概要

boolean	containsKey(String itemName) この CompositeType インスタンスが itemName という名前の項目を定義する場合、true を返します。
boolean	equals(Object obj) 指定された obj パラメータとこの CompositeType インスタンスが等しいかどうかを比較します。
String	getDescription(String itemName) itemName という名前の項目の説明を返します。
OpenType<?>	getType(String itemName) itemName という名前の項目の「公開型」を返します。
int	hashCode() この CompositeType インスタンスのハッシュコード値を返します。
boolean	isValue(Object obj) obj が、この CompositeType インスタンスで記述可能な値であるかどうかをテストします。
Set<String>	keySet() この CompositeType インスタンスによって定義されたすべての項目名の変更不能な Set ビューを返します。
String	toString() この CompositeType インスタンスの文字列表現を返します。

クラス javax.management.openmbean.OpenType から継承されたメソッド

getClassName, getDescription, getTypeName, isArray

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

CompositeType

public CompositeType(String typeName,
                     String description,
                     String[] itemNames,
                     String[] itemDescriptions,
                     OpenType<?>[] itemTypes)
              throws OpenDataException

CompositeType インスタンスを構築し、指定されたパラメータの妥当性を検査します。各パラメータの妥当性の制約は、以下で説明します。

itemNames、itemDescriptions、および itemTypes の 3 つの配列パラメータの内容は、このコンストラクタの呼び出し側によってこれらの配列が変更されても、構築済みの CompositeType インスタンスに影響が及ばないようにするため、内部でコピーされます。

この複合型が示す複合データ値の Java クラス名 (getClassName メソッドによって返されるクラス名) は、CompositeData.class.getName() によって返される文字列値に設定されます。

パラメータ:

typeName - このインスタンスが示す複合型に付与する名前。 null または空文字列は使用できない

description - このインスタンスが示す複合型についての人間が読める形式の説明。 null または空文字列は使用できない

itemNames - この CompositeType インスタンスによって記述された複合データ値に含まれる項目の名前。 null は不可。 null または空文字列以外の 1 個以上の要素を含む必要がある。 CompositeType インスタンスとその他のインスタンスの差分を取る上で、 項目名の指定順は重要ではない。 項目名はアルファベットの昇順でソートされ、内部で格納される

itemDescriptions - この CompositeType インスタンスによって記述された複合データ値に含まれる項目の記述。 itemNames と同じ順で並べられる。 itemNames と同じサイズでなければならない。 要素は null または空文字列以外

itemTypes - 公開型インスタンス。itemNames と同じ順で並べられ、 この CompositeType インスタンスによって記述された複合データ値に含まれる項目を記述する。 itemNames と同じサイズでなければならない。 要素は null 以外

例外:

IllegalArgumentException - typeName または description が null または空文字列の場合、 itemNames、itemDescriptions、または itemTypes が null の場合、 itemNames または itemDescriptions のいずれかの要素が null または空文字列の場合、 itemTypes のいずれかの要素が null の場合、 または、itemNames、itemDescriptions、または itemTypes の サイズが異なる場合

OpenDataException - itemNames に重複した項目名が含まれる場合 (項目名の大文字と小文字は区別されるが、前後の空白文字は無視される)

メソッドの詳細

containsKey

public boolean containsKey(String itemName)

この CompositeType インスタンスが itemName という名前の項目を定義する場合、true を返します。

パラメータ:

itemName - 項目の名前

戻り値:

この名前の項目が存在する場合は true

getDescription

public String getDescription(String itemName)

itemName という名前の項目の説明を返します。この CompositeType インスタンスが itemName という名前の項目を定義しない場合は null を返します。

パラメータ:

itemName - 項目の名前

戻り値:

説明

getType

public OpenType<?> getType(String itemName)

itemName という名前の項目の「公開型」を返します。この CompositeType インスタンスが itemName という名前の項目を定義しない場合は null を返します。

パラメータ:

itemName - 時間の名前

戻り値:

型

keySet

public Set<String> keySet()

この CompositeType インスタンスによって定義されたすべての項目名の変更不能な Set ビューを返します。セットの反復子は、項目名を昇順で返します。

戻り値:

String の Set

isValue

public boolean isValue(Object obj)

obj が、この CompositeType インスタンスで記述可能な値であるかどうかをテストします。

obj が null または javax.management.openmbean.CompositeData のインスタンスでない場合、isValue は false を返します。

obj が javax.management.openmbean.CompositeData のインスタンスである場合、ct を、CompositeData.getCompositeType() により返される CompositeType にします。this を ct から割り当て可能な場合、結果は true になります。 これは次のことを意味します。

• this.getTypeName() が ct.getTypeName() に等しい。
• ct 内に存在しない項目名は、this 内にも存在しない。
• this 内のどの項目についても、その型を ct 内の対応する項目の型から割り当てることができる。

typeName および index name list が同じであり、最初の row type を 2 番目の行型から割り当て可能である場合、TabularType を別の TabularType から割り当てることができます。

dimension が同じで、両方とも primitive arrays であるか、primitive arrays でない場合、および最初の element type を 2 番目の要素型から割り当て可能である場合、ArrayType を別の ArrayType から割り当てることができます。

それ以外では、OpenType を別の OpenType から割り当てることができるのは、両者が等しい場合だけです。

これらの規則は、補足項目を持たない CompositeType に対して CompositeData を有効にすることなく、それらの補足項目を CompositeData に追加できることを意味します。

定義:

クラス OpenType<CompositeData> 内の isValue

パラメータ:

obj - この CompositeType インスタンスとの互換性を判定する公開型を持つ値

戻り値:

obj がこの複合型の値である場合は true、 そうでない場合は false

equals

public boolean equals(Object obj)

指定された obj パラメータとこの CompositeType インスタンスが等しいかどうかを比較します。

次のすべての条件が満たされている場合に限り、2 つの CompositeType インスタンスは等しいと言えます。

• 型名が等しい
• 項目の名前および型が等しい

定義:

クラス OpenType<CompositeData> 内の equals

パラメータ:

obj - この CompositeType インスタンスと等しいかどうか比較されるオブジェクト。 obj が null の場合、equals は false を返す

戻り値:

指定されたオブジェクトがこの CompositeType と等しい場合は true

関連項目:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

この CompositeType インスタンスのハッシュコード値を返します。

CompositeType インスタンスのハッシュコードは、equals の比較で使用されるすべての情報要素 (名前、項目名、および項目型) のハッシュコードの合計になります。このため、t1.equals(t2) は、2 つの CompositeType インスタンス t1 および t2 の t1.hashCode()==t2.hashCode() が、Object.hashCode() メソッドの一般規約に従っていることを示します。

CompositeType インスタンスは不変で、このインスタンスのハッシュコードは、hashCode の最初の呼び出し時に 1 回だけ計算されます。その後の呼び出しには、同じ値が返されます。

定義:

クラス OpenType<CompositeData> 内の hashCode

戻り値:

この CompositeType インスタンスのハッシュコード値

関連項目:

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

toString

public String toString()

この CompositeType インスタンスの文字列表現を返します。

文字列表現は、このクラスの名前 (javax.management.openmbean.CompositeType)、このインスタンスの型名、このインスタンスの項目名および型の文字列表現で構成されます。

CompositeType インスタンスは不変で、このインスタンスの文字列表現は、toString の最初の呼び出し時に 1 回だけ計算されます。その後の呼び出しには、同じ値が返されます。

定義:

クラス OpenType<CompositeData> 内の toString

戻り値:

この CompositeType インスタンスの文字列表現