compact3

javax.management.relation

クラスRelationTypeSupport

java.lang.Object

javax.management.relation.RelationTypeSupport

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

Serializable, RelationType

public class RelationTypeSupport
extends Object
implements RelationType

RelationTypeSupportオブジェクトは、RelationTypeインタフェースを実装します。

このオブジェクトは関係タイプを表現し、その型のすべての関係でサポートされるロールの情報を提供します。

関係タイプには、関係タイプ名と、RoleInfoオブジェクトで表現されるロール情報のリストが含まれます。

関係タイプは、次のいずれかの方法で関係サービス内に宣言する必要があります。

- createRelationType()メソッドを使用。このメソッドは、RelationTypeSupportオブジェクトを作成し、関係サービス内に格納する。

- addRelationType()メソッドを使用。ユーザーは、このメソッドを使って、RelationTypeインタフェースを実装するオブジェクトを作成する必要がある。このオブジェクトが、関係サービス内の関係タイプの表現として使用される。

このクラスのserialVersionUIDは4611072955724144607Lです。

導入されたバージョン:

1.5

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	RelationTypeSupport(String relationTypeName) サブクラス用のコンストラクタです。
	RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) すべてのロール定義が動的に作成され、パラメータとして渡されるコンストラクタです。

メソッドのサマリー

修飾子と型	メソッドと説明
protected void	addRoleInfo(RoleInfo roleInfo) ロール情報を追加します。
String	getRelationTypeName() 関係タイプ名を返します。
RoleInfo	getRoleInfo(String roleInfoName) 指定されたロール情報名のロール情報(RoleInfoオブジェクト)を返します。見つからない場合はnullを返します。
List<RoleInfo>	getRoleInfos() ロール定義のリスト(RoleInfoオブジェクトから成るArrayList)を返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

RelationTypeSupport

public RelationTypeSupport(String relationTypeName,
                           RoleInfo[] roleInfoArray)
                    throws IllegalArgumentException,
                           InvalidRelationTypeException

すべてのロール定義が動的に作成され、パラメータとして渡されるコンストラクタです。

パラメータ:

relationTypeName - 関係タイプの名前

roleInfoArray - ロール定義(RoleInfoオブジェクト)のリスト

例外:

IllegalArgumentException - パラメータがnullの場合

InvalidRelationTypeException - 次の場合:

- 同じ名前が2つの異なったロールで使用されている場合

- ロール情報が提供されなかった場合

- ロール情報としてnullが提供された場合

RelationTypeSupport

protected RelationTypeSupport(String relationTypeName)

サブクラス用のコンストラクタです。

パラメータ:

relationTypeName - 関係タイプの名前。

例外:

IllegalArgumentException - パラメータがnullの場合。

メソッドの詳細

getRelationTypeName

public String getRelationTypeName()

関係タイプ名を返します。

定義:

getRelationTypeName、インタフェース: RelationType

戻り値:

関係タイプ名

getRoleInfos

public List<RoleInfo> getRoleInfos()

ロール定義のリスト(RoleInfoオブジェクトから成るArrayList)を返します。

定義:

getRoleInfos、インタフェース: RelationType

戻り値:

RoleInfoのArrayList

getRoleInfo

public RoleInfo getRoleInfo(String roleInfoName)
                     throws IllegalArgumentException,
                            RoleInfoNotFoundException

指定されたロール情報名のロール情報(RoleInfoオブジェクト)を返します。見つからない場合はnullを返します。

定義:

getRoleInfo、インタフェース: RelationType

パラメータ:

roleInfoName - ロール情報名

戻り値:

ロール定義が存在しない場合はRoleInfoオブジェクト

例外:

IllegalArgumentException - パラメータがnullの場合

RoleInfoNotFoundException - その名前のロール情報が関係タイプ内に存在しない場合。

addRoleInfo

protected void addRoleInfo(RoleInfo roleInfo)
                    throws IllegalArgumentException,
                           InvalidRelationTypeException

ロール情報を追加します。このメソッドは、関係タイプの作成後は使用できません。関係タイプが更新されると、作成時に関係タイプに関連付けられた関係が、元の関係タイプに適合しなくなるからです。関係サービス内に宣言された関係タイプを更新しようとすると、RuntimeExceptionがスローされる可能性があります。

パラメータ:

roleInfo - 追加されるロール情報。

例外:

IllegalArgumentException - パラメータがnullの場合。

InvalidRelationTypeException - 現在の関連型に同じ名前のロール情報がすでに含まれている場合。