compact3

javax.management.relation

クラスRoleInfo

java.lang.Object

javax.management.relation.RoleInfo

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

Serializable

public class RoleInfo
extends Object
implements Serializable

RoleInfoオブジェクトは、関係タイプに含まれるロールを集計します。

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

導入されたバージョン:

1.5

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static int	ROLE_CARDINALITY_INFINITY 無制限のカーディナリティを指定するためです。

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

コンストラクタ

コンストラクタと説明
RoleInfo(RoleInfo roleInfo) コンストラクタをコピーします。
RoleInfo(String roleName, String mbeanClassName) コンストラクタです。
RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write) コンストラクタです。
RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr) コンストラクタです。

メソッドのサマリー

修飾子と型	メソッドと説明
boolean	checkMaxDegree(int value) valueパラメータが最大値以下の場合はtrue、そうでない場合はfalseを返します。
boolean	checkMinDegree(int value) valueパラメータが最小値以上の場合はtrue、そうでない場合はfalseを返します。
String	getDescription() ロールの説明テキストを返します。
int	getMaxDegree() 対応するロール参照の最大値を返します。
int	getMinDegree() 対応するロール参照の最小値を返します。
String	getName() ロール名を返します。
String	getRefMBeanClassName() 対応するロール内で参照されるMBean (複数可)の型名を返します。
boolean	isReadable() ロールの読取りアクセス・モードを返します(読取り可能な場合はtrue)。
boolean	isWritable() ロールの書込みアクセス・モードを返します(書込み可能な場合はtrue)。
String	toString() ロール情報について説明する文字列を返します。

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

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

フィールドの詳細

ROLE_CARDINALITY_INFINITY

public static final int ROLE_CARDINALITY_INFINITY

無制限のカーディナリティを指定するためです。

関連項目:

定数フィールド値

コンストラクタの詳細

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write,
                int min,
                int max,
                String descr)
         throws IllegalArgumentException,
                InvalidRoleInfoException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名。

mbeanClassName - 対応するロール内で参照されるMBean (複数可)のクラス名。MBean Mがこのロールに含まれる場合、MBeanサーバーはisInstanceOf(M, mbeanClassName)に対してtrueを返す必要がある。

read - 対応するロールが読取り可能かどうかを示すフラグ

write - 対応するロールが設定可能かどうかを示すフラグ

min - ロールの最小値(対応するロールに含まれるMBeanの最大数)。max以下でなければならない。(数を制限しない場合、ROLE_CARDINALITY_INFINITY)

max - ロールの最大値(対応するロールに含まれるMBeanの最大数)。min以上でなければならない(数を制限しない場合、ROLE_CARDINALITY_INFINITY)

descr - ロールの説明(nullも可)

例外:

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

InvalidRoleInfoException - 最小値が最大値より大きい場合。

ClassNotFoundException - JMX 1.2以降、この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、このクラスの宣言に引き続き含まれている。

NotCompliantMBeanException - mbeanClassNameクラスがMBeanクラスでない場合。

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名

mbeanClassName - 対応するロール内で参照されるMBean (複数可)のクラス名。MBean Mがこのロールに含まれる場合、MBeanサーバーはisInstanceOf(M, mbeanClassName)に対してtrueを返す必要がある。

read - 対応するロールが読取り可能かどうかを示すフラグ

write - 対応するロールが設定可能かどうかを示すフラグ

最小値と最大値のデフォルト値は1です。

ロールの説明のデフォルト値はnullです。

例外:

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

ClassNotFoundException - JMX 1.2以降、この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、このクラスの宣言に引き続き含まれている。

NotCompliantMBeanException - JMX 1.2以降、この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、このクラスの宣言に引き続き含まれている。

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名

mbeanClassName - 対応するロール内で参照されるMBean (複数可)のクラス名。MBean Mがこのロールに含まれる場合、MBeanサーバーはisInstanceOf(M, mbeanClassName)に対してtrueを返す必要がある。

IsReadableとIsWritableのデフォルト値はtrueです。

最小値と最大値のデフォルト値は1です。

ロールの説明のデフォルト値はnullです。

例外:

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

ClassNotFoundException - JMX 1.2以降、この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、このクラスの宣言に引き続き含まれている。

NotCompliantMBeanException - JMX 1.2以降、この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、このクラスの宣言に引き続き含まれている。

RoleInfo

public RoleInfo(RoleInfo roleInfo)
         throws IllegalArgumentException

コンストラクタをコピーします。

パラメータ:

roleInfo - コピーされるRoleInfoインスタンス。

例外:

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

メソッドの詳細

getName

public String getName()

ロール名を返します。

戻り値:

ロール名。

isReadable

public boolean isReadable()

ロールの読取りアクセス・モードを返します(読取り可能な場合はtrue)。

戻り値:

ロールが読取り可能な場合はtrue。

isWritable

public boolean isWritable()

ロールの書込みアクセス・モードを返します(書込み可能な場合はtrue)。

戻り値:

ロールが書込み可能な場合はtrue。

getDescription

public String getDescription()

ロールの説明テキストを返します。

戻り値:

ロールの説明。

getMinDegree

public int getMinDegree()

対応するロール参照の最小値を返します。

戻り値:

最小値

getMaxDegree

public int getMaxDegree()

対応するロール参照の最大値を返します。

戻り値:

最大値。

getRefMBeanClassName

public String getRefMBeanClassName()

対応するロール内で参照されるMBean (複数可)の型名を返します。

戻り値:

参照型名。

checkMinDegree

public boolean checkMinDegree(int value)

valueパラメータが最小値以上の場合はtrue、そうでない場合はfalseを返します。

パラメータ:

value - チェック対象の値

戻り値:

最小値以上の場合はtrue、そうでない場合はfalse。

checkMaxDegree

public boolean checkMaxDegree(int value)

valueパラメータが最大値以下の場合はtrue、そうでない場合はfalseを返します。

パラメータ:

value - チェック対象の値

戻り値:

最大値以下の場合はtrue、そうでない場合はfalse。

toString

public String toString()

ロール情報について説明する文字列を返します。

オーバーライド:

toString、クラス: Object

戻り値:

ロール情報の説明。