compact3

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という名前の項目の説明を返します。このCompositeTypeインスタンスがitemNameという名前の項目を定義しない場合はnullを返します。
OpenType<?>	getType(String itemName) itemNameという名前の項目の公開型を返します。このCompositeTypeインスタンスがitemNameという名前の項目を定義しない場合はnullを返します。
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 - このインスタンスが示す複合型についての人間が読める形式の説明。

itemNames - このCompositeTypeインスタンスによって記述された複合データ値に含まれる項目の名前。nullは不可で、要素が少なくとも1つ含まれる必要がある。要素はnullまたは空文字列以外。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()に等しい。
• this内に存在しない項目名は、ct内にも存在しない。
• this内のどの項目についても、その型をct内の対応する項目の型から割り当てることができる。

型名およびインデックス名リストが同じであり、最初の行の型を2番目の行の型から割当て可能である場合、TabularTypeを別のTabularTypeから割り当てることができます。

次元が同じで、両方ともプリミティブ配列であるか、プリミティブ配列でない場合、および最初の要素型を2番目の要素型から割当て可能である場合、ArrayTypeを別のArrayTypeから割り当てることができます。

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

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

定義:

isValue、クラス: OpenType<CompositeData>

パラメータ:

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

戻り値:

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

equals

public boolean equals(Object obj)

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

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

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

定義:

equals、クラス: OpenType<CompositeData>

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

hashCode

public int hashCode()

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

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

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

定義:

hashCode、クラス: OpenType<CompositeData>

戻り値:

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

関連項目:

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

toString

public String toString()

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

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

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

定義:

toString、クラス: OpenType<CompositeData>

戻り値:

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