モジュール java.naming

パッケージ javax.naming.directory

クラスBasicAttribute

java.lang.Object

javax.naming.directory.BasicAttribute

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

Serializable, Cloneable, Attribute

public class BasicAttribute extends Object implements Attribute

このクラスは、Attributeインタフェースの基本的な実装を提供します。

この実装では、スキーマ・メソッドgetAttributeDefinition()およびgetAttributeSyntaxDefinition()はサポートされていません。 単にOperationNotSupportedExceptionをスローします。 BasicAttributeのサブクラスは、これらのメソッドがサポートされている場合はオーバーライドする必要があります。

BasicAttributeクラスは、デフォルトでObject.equals()を使用して、等価のテスト時または値の検索時に、値が配列の場合は「除く」の属性値の等価性を判断します。 配列の場合、配列の各要素がObject.equals()を使用してチェックされます。 BasicAttributeのサブクラスは、同様の等価性チェックを行うときに、スキーマの使用が意味のあるメソッドをオーバーライドすることで、スキーマ情報を使用できます。 同様に、BasicAttributeクラスは、デフォルトでそのコンストラクタに渡された値、またはadd/removeメソッドを使用して操作された値(あるいはその両方)を返します。 BasicAttributeのサブクラスは、get()およびgetAll()をオーバーライドして、ディレクトリ(または、BasicAttributeをサブクラス化するのではなく、Attributeインタフェースを直接実装)から動的に値を取得できます。

BasicAttribute (値の追加や削除など)の更新は、ディレクトリ内の属性の対応する表現には影響しないことに注意してください。 ディレクトリの更新は、DirContextインタフェースの操作を使用してのみ変更できます。

BasicAttributeインスタンスは、同時マルチスレッド・アクセスに対して同期されません。 複数のスレッドがBasicAttributeにアクセスして変更しようとすると、オブジェクトがロックされます。

導入されたバージョン:

1.3

関連項目:

• 直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
protected String	attrID	属性のIDを保持します。
protected boolean	ordered	この属性の値が順序付けされるかどうかを記録するフラグです。
protected Vector<Object>	values	属性の値を保持します。

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

コンストラクタ

コンストラクタ	説明
BasicAttribute(String id)	順序付けされていない属性のインスタンスを値なしで新しく構築します。
BasicAttribute(String id, boolean ordered)	順序付けされる可能性のある属性のインスタンスを値なしで新しく構築します。
BasicAttribute(String id, Object value)	順序付けされていない属性のインスタンスを単一の値で新しく構築します。
BasicAttribute(String id, Object value, boolean ordered)	順序付けされる可能性のある属性のインスタンスを単一の値で新しく構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	add(int ix, Object attrVal)	属性値を属性値の順序付けられたリストに追加します。
boolean	add(Object attrVal)	この属性に新しい値を追加します。
void	clear()	この属性からすべての値を削除します。
Object	clone()	属性のコピーを作成します。
boolean	contains(Object attrVal)	値がこの属性にあるかどうかを判定します。
boolean	equals(Object obj)	objがこの属性と同一かどうかを判別します。
Object	get()	この属性の値の1つを検出します。
Object	get(int ix)	属性値の順序付けられたリストから属性値を取り出します。
NamingEnumeration<?>	getAll()	この属性の値の列挙を取り出します。
DirContext	getAttributeDefinition()	この属性のスキーマ定義を取り出します。
DirContext	getAttributeSyntaxDefinition()	この属性に関連付けられている構文の定義を検索します。
String	getID()	この属性のIDを取り出します。
int	hashCode()	この属性のハッシュ・コードを計算します。
boolean	isOrdered()	属性値が順序付けられているかどうかを判別します。
Object	remove(int ix)	属性値の順序付けられたリストから属性値を削除します。
boolean	remove(Object attrval)	指定された値をこの属性から削除します。
Object	set(int ix, Object attrVal)	属性値の順序付けられたリストの属性値を設定します。
int	size()	この属性の値数を取り出します。
String	toString()	この属性の文字列表記を生成します。

クラスjava.lang.Objectで宣言されたメソッド

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

フィールド詳細

attrID

protected String attrID

属性のIDを保持します。 IDはpublicコンストラクタによって初期化され、attrIDを使用しているBasicAttributeのメソッドがオーバーライドされていない限り、nullにできません。

values

protected transient Vector<Object> values

属性の値を保持します。 publicコンストラクタによって初期化されます。 値を使用するBasicAttributeのメソッドがオーバーライドされていない限り、nullにできません。

ordered

protected boolean ordered

この属性の値が順序付けされるかどうかを記録するフラグです。

コンストラクタの詳細

BasicAttribute

public BasicAttribute(String id)

順序付けされていない属性のインスタンスを値なしで新しく構築します。

パラメータ:

id - 属性のID。 nullは不可。

BasicAttribute

public BasicAttribute(String id, Object value)

順序付けされていない属性のインスタンスを単一の値で新しく構築します。

パラメータ:

id - 属性のID。 nullは不可。

value - 属性の値。 nullの場合は、null値が属性に追加される。

BasicAttribute

public BasicAttribute(String id, boolean ordered)

順序付けされる可能性のある属性のインスタンスを値なしで新しく構築します。

パラメータ:

id - 属性のID。 nullは不可。

ordered - trueは、属性の値が順序付けされることを示す。それ以外の場合はfalse。

BasicAttribute

public BasicAttribute(String id, Object value, boolean ordered)

順序付けされる可能性のある属性のインスタンスを単一の値で新しく構築します。

パラメータ:

id - 属性のID。 nullは不可。

value - 属性の値。 nullの場合は、null値が属性に追加される。

ordered - trueは、属性の値が順序付けされることを示す。それ以外の場合はfalse。

メソッドの詳細

clone

public Object clone()

インタフェースからコピーされた説明: Attribute

属性のコピーを作成します。 コピーには元の属性と同じ属性値が含まれます。属性値そのものは複製されません。 コピーに変更を加えても元の属性には影響ありません。また逆の場合も同じです。

定義:

clone、インタフェースAttribute

オーバーライド:

clone、クラスObject

戻り値:

この属性のnull以外のコピー。

関連項目:

• Cloneable

equals

public boolean equals(Object obj)

objがこの属性と同一かどうかを判別します。 2つの属性の属性ID、構文、および値が等しい場合、2つの属性は同一です。 2つの属性の値が順序付けされていない場合、値が追加された順序は関係ありません。 属性値が順序付けされている場合、値の順序は一致する必要があります。 objがnullであるか、またはAttributeではない場合、falseが返されます。

デフォルトでは、値が配列の場合を除き、属性IDとその値を比較するときにObject.equals()が使用されます。 配列の場合、配列の各要素がObject.equals()を使用してチェックされます。 サブクラスはこれをオーバーライドして、スキーマ構文情報、および2つの属性にとって同一が何を意味するかを定義する一致規則を使用できます。 サブクラスがスキーマ情報を使用するかどうか、またどのように使用するかは、サブクラスが決定します。 サブクラスがequals()をオーバーライドする場合、同じ2つの属性が同じハッシュ・コードを持つように、hashCode()もオーバーライドする必要があります。

オーバーライド:

equals、クラスObject

パラメータ:

obj - チェックするnullの可能性があるオブジェクト。

戻り値:

objがこの属性と等しい場合はtrue、そうでない場合はfalse。

関連項目:

• hashCode()
• contains(java.lang.Object)

hashCode

public int hashCode()

この属性のハッシュ・コードを計算します。

ハッシュ・コードは、属性のIDのハッシュ・コード、および値が配列である場合を除く属性の値すべてのハッシュ・コードを加算することによって計算されます。 配列の場合は、配列の各要素のハッシュ・コードが合計されます。 サブクラスがhashCode()をオーバーライドする場合、同じ2つの属性が同じハッシュ・コードを持つように、equals()もオーバーライドする必要があります。

オーバーライド:

hashCode、クラスObject

戻り値:

この属性のハッシュ・コードを表すint。

関連項目:

• equals(java.lang.Object)

toString

public String toString()

この属性の文字列表記を生成します。 文字列は属性のIDおよび属性の値から構成されます。 この文字列はデバッグ用に使用されますが、プログラムによって解釈されることはありません。

オーバーライド:

toString、クラスObject

戻り値:

この属性のnull以外の文字列表現。

getAll

public NamingEnumeration<?> getAll() throws NamingException

この属性の値の列挙を取り出します。

デフォルトでは、戻り値は、コンストラクタに渡された値、または追加置換削除メソッドを使用して処理された値、あるいはその両方です。 サブクラスはこの値をオーバーライドして、ディレクトリから直接値を検出できます。

定義:

getAll、インタフェースAttribute

戻り値:

属性値のnull以外の列挙。 列挙の各要素はnullオブジェクトの可能性がある。 オブジェクトのクラスは属性値のクラスである。 属性値がnullの場合は要素はnullになる。 属性にゼロ値が含まれる場合は空の列挙が返される。

例外:

NamingException - 値の取得中にネーミング例外が検出された場合。

関連項目:

• Attribute.isOrdered()

get

public Object get() throws NamingException

この属性の値の1つを検出します。

デフォルトでは、戻り値は、コンストラクタに渡された値、または追加置換削除メソッドを使用して処理された値、あるいはその両方のうちの1つです。 サブクラスはこの値をオーバーライドして、ディレクトリから直接値を検出できます。

定義:

get、インタフェースAttribute

戻り値:

nullの可能性がある、属性値の1つを表すオブジェクト。 属性値がnullの場合はnull。

例外:

NamingException - 値の取得中にネーミング例外が検出された場合。

size

public int size()

インタフェースからコピーされた説明: Attribute

この属性の値数を取り出します。

定義:

size、インタフェースAttribute

戻り値:

この属性の負でない値数。

getID

public String getID()

インタフェースからコピーされた説明: Attribute

この属性のIDを取り出します。

定義:

getID、インタフェースAttribute

戻り値:

この属性のID。 nullは不可。

contains

public boolean contains(Object attrVal)

値がこの属性にあるかどうかを判定します。

デフォルトでは、Object.equals()は、attrValが配列の場合を除き、attrValをこの属性の値と比較するときに使用されます。 配列の場合、配列の各要素がObject.equals()を使用してチェックされます。 サブクラスがスキーマ情報を使用して同一性を判定する場合があります。

定義:

contains、インタフェースAttribute

パラメータ:

attrVal - チェックするnullの可能性がある値。 nullの場合、属性がnull値の属性値を持つかどうかを判定する。

戻り値:

attrValがこの属性値の1つである場合はtrue、そうでない場合はfalse。

関連項目:

• Object.equals(java.lang.Object)
• equals(java.lang.Object)

add

public boolean add(Object attrVal)

この属性に新しい値を追加します。

デフォルトでは、Object.equals()は、attrValが配列の場合を除き、attrValをこの属性の値と比較するときに使用されます。 配列の場合、配列の各要素がObject.equals()を使用してチェックされます。 サブクラスがスキーマ情報を使用して同一性を判定する場合があります。

定義:

add、インタフェースAttribute

パラメータ:

attrVal - 追加する新しいnullの可能性がある値。 nullの場合は、nullが属性値として追加されます。

戻り値:

値が追加された場合はtrue、そうでない場合はfalse。

remove

public boolean remove(Object attrval)

指定された値をこの属性から削除します。

デフォルトでは、Object.equals()は、attrValが配列の場合を除き、attrValをこの属性の値と比較するときに使用されます。 配列の場合、配列の各要素がObject.equals()を使用してチェックされます。 サブクラスがスキーマ情報を使用して同一性を判定する場合があります。

定義:

remove、インタフェースAttribute

パラメータ:

attrval - この属性から削除するnullの可能性がある値。 nullの場合、nullの属性値が削除される。

戻り値:

値が削除された場合はtrue、そうでない場合はfalse。

clear

public void clear()

インタフェースからコピーされた説明: Attribute

この属性からすべての値を削除します。

定義:

clear、インタフェースAttribute

isOrdered

public boolean isOrdered()

インタフェースからコピーされた説明: Attribute

属性値が順序付けられているかどうかを判別します。 属性値が順序付けられている場合は、複製値が許可されます。 属性値が順序付けられていない場合は、値は任意の順序で表示され、複製値はありません。

定義:

isOrdered、インタフェースAttribute

戻り値:

この属性値が順序付けられている場合はtrue、そうでない場合はfalse。

関連項目:

• Attribute.get(int)
• Attribute.remove(int)
• Attribute.add(int, java.lang.Object)
• Attribute.set(int, java.lang.Object)

get

public Object get(int ix) throws NamingException

インタフェースからコピーされた説明: Attribute

属性値の順序付けられたリストから属性値を取り出します。 このメソッドは、属性値のリストのix索引の値を返します。 属性値が順序付けられていない場合、このメソッドはそのインデックスの位置にある値を返します。

定義:

get、インタフェースAttribute

パラメータ:

ix - 属性値の順序付けられたリスト内の値のインデックス。0 <= ix < size()。

戻り値:

索引ixでNULLの可能性がある属性値。属性値がnullの場合はnull。

例外:

NamingException - 値の取得中にネーミング例外が検出された場合。

remove

public Object remove(int ix)

インタフェースからコピーされた説明: Attribute

属性値の順序付けられたリストから属性値を削除します。 このメソッドは、属性値のリストのix索引の値を削除します。 属性値が順序付けられていない場合は、このメソッドはそのインデックスにあった値を削除します。 ixより大きいインデックスにある値は、リスト (それらの指標は1つずつ減少)の前方にシフトされます。

定義:

remove、インタフェースAttribute

パラメータ:

ix - 削除する値のインデックス。0 <= ix < size()。

戻り値:

削除された索引ixの属性値がNULLである可能性があります。属性値がnullの場合はnullです。

add

public void add(int ix, Object attrVal)

インタフェースからコピーされた説明: Attribute

属性値を属性値の順序付けられたリストに追加します。 このメソッドは、attrValを索引ixの属性値のリストに追加します。 ix以上の索引にある値は、リスト(インデックスが1ずつ増加)の最後にシフトされます。 属性値が順序付けされず、すでにattrValがある場合、IllegalStateExceptionがスローされます。

定義:

add、インタフェースAttribute

パラメータ:

ix - 新しい値を追加する属性値の順序付けられたリスト内のインデックス。0 <= ix <= size()。

attrVal - 追加するnullの可能性がある属性値。nullの場合は、nullが値として追加される。

set

public Object set(int ix, Object attrVal)

インタフェースからコピーされた説明: Attribute

属性値の順序付けられたリストの属性値を設定します。 このメソッドは、属性値のリストのix索引の値をattrValに設定します。 古い値は削除されます。 属性値が順序付けされていない場合、このメソッドは、attrValがすでにいずれかの値でないかぎり、その索引にある値にattrValを設定します。 その場合は、IllegalStateExceptionがスローされます。

定義:

set、インタフェースAttribute

パラメータ:

ix - 属性値の順序付けられたリスト内の値のインデックス。0 <= ix < size()。

attrVal - 使用するnullの可能性がある属性値。 nullの場合、古い値がnullに変換される。

戻り値:

nullの可能性がある、置換されたインデックスixにある属性値。 属性値がnullの場合はnull。

getAttributeSyntaxDefinition

public DirContext getAttributeSyntaxDefinition() throws NamingException

この属性に関連付けられている構文の定義を検索します。

このメソッドはデフォルトではOperationNotSupportedExceptionをスローします。 サブクラスがスキーマをサポートする場合、サブクラスがこのメソッドをオーバーライドします。

定義:

getAttributeSyntaxDefinition、インタフェースAttribute

戻り値:

属性の構文定義。 実装がスキーマをサポートしても、この特定の属性にスキーマ情報が含まれていない場合はnull。

例外:

OperationNotSupportedException - スキーマの取得がサポートされていない場合。

NamingException - スキーマの取得中にネーミング例外が発生した場合。

getAttributeDefinition

public DirContext getAttributeDefinition() throws NamingException

この属性のスキーマ定義を取り出します。

このメソッドはデフォルトではOperationNotSupportedExceptionをスローします。 サブクラスがスキーマをサポートする場合、サブクラスがこのメソッドをオーバーライドします。

定義:

getAttributeDefinition、インタフェースAttribute

戻り値:

この属性のスキーマ定義。 実装がスキーマをサポートしても、この特定の属性にスキーマ情報が含まれていない場合はnull。

例外:

OperationNotSupportedException - スキーマの取得がサポートされていない場合。

NamingException - スキーマの取得中にネーミング例外が発生した場合。