javax.naming.directory

インタフェース Attributes

すべてのスーパーインタフェース:

Cloneable, Serializable

既知のすべての実装クラス:

BasicAttributes

public interface Attributes
extends Cloneable, Serializable

このインタフェースは属性のコレクションを表します。

ディレクトリでは、指定されたオブジェクトはそれらの属性と関連付けることができます。Attributes インタフェースは属性のコレクションを表します。たとえば、1 つのオブジェクトに関連付けられている複数の属性をディレクトリに要求できます。それらの属性は、Attributes インタフェースを実装する 1 つのオブジェクトで返されます。

Attributes インタフェースを実装する 1 つのオブジェクトに含まれる属性は順序付けられていません。オブジェクトにはゼロ以上の属性を含むことができます。属性は大文字と小文字を区別する場合と、区別しない場合があります。このプロパティーは、Attributes オブジェクトが作成された時点で決定されます。(たとえば、BasicAttributes コンストラクタを参照してください)。大文字と小文字を区別しない Attributes では、属性を検索する場合や属性を追加する場合に属性識別子の大文字と小文字は無視されます。大文字と小文字を区別する Attributes では、大文字と小文字の区別は重要です。

Attributes の変更 (属性の追加、削除など) は、該当するディレクトリでの表示には影響しません。ディレクトリの変更は、DirContext インタフェースの操作を使用した場合に限り、有効になります。

導入されたバージョン:

1.3

関連項目:

DirContext.getAttributes(javax.naming.Name), DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes), DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes), DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[]), BasicAttributes

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Object	clone() 属性セットのコピーを作成します。
Attribute	get(String attrID) 属性セットから、指定された属性 ID を持つ属性を取り込みます。
NamingEnumeration<? extends Attribute>	getAll() 属性セットの属性の列挙を取り出します。
NamingEnumeration<String>	getIDs() 属性セットの属性 ID の列挙を取り出します。
boolean	isCaseIgnored() 属性の取り込みまたは追加をしているときに、属性セットが属性識別子の大文字と小文字を無視するかどうかを判別します。
Attribute	put(Attribute attr) 属性セットに新しい属性を追加します。
Attribute	put(String attrID, Object val) 属性セットに新しい属性を追加します。
Attribute	remove(String attrID) 属性セットから属性 ID「attrID」を持つ属性を削除します。
int	size() 属性セットの属性数を取り込みます。

メソッドの詳細

isCaseIgnored

boolean isCaseIgnored()

属性の取り込みまたは追加をしているときに、属性セットが属性識別子の大文字と小文字を無視するかどうかを判別します。

戻り値:

大文字と小文字が無視される場合は true、そうでない場合は false。

size

int size()

属性セットの属性数を取り込みます。

戻り値:

この属性セットの負でない属性数。

get

Attribute get(String attrID)

属性セットから、指定された属性 ID を持つ属性を取り込みます。

パラメータ:

attrID - 取得する属性の null 以外の ID。この属性セットが属性 ID の大文字と小文字を区別しない場合、attrID の大文字と小文字は区別されない。

戻り値:

attrID で識別される属性。検出されない場合は null。

関連項目:

put(java.lang.String, java.lang.Object), remove(java.lang.String)

getAll

NamingEnumeration<? extends Attribute> getAll()

属性セットの属性の列挙を取り出します。この列挙でこの属性セットを変更した場合の効果は定義されていません。

戻り値:

この属性セット内の null 以外の属性の列挙。列挙の各要素は、クラス Attribute になる。属性セットにゼロ属性がある場合、空の列挙が返される。

getIDs

NamingEnumeration<String> getIDs()

属性セットの属性 ID の列挙を取り出します。この列挙でこの属性セットを変更した場合の効果は定義されていません。

戻り値:

この属性セットの属性 ID の null 以外の列挙。列挙された各要素のクラスは String。属性セットにゼロ属性がある場合、空の列挙が返される。

put

Attribute put(String attrID,
            Object val)

属性セットに新しい属性を追加します。

パラメータ:

attrID - 追加する属性の null 以外の ID。属性セットがその属性 ID の大文字と小文字を無視する場合、attrID の大文字と小文字は無視される。

val - 追加する属性の null の可能性がある値。null の場合、この属性には値が含まれない。

戻り値:

この属性セットに以前存在していた attrID を持つ Attribute。そのような属性が存在しなかった場合は null。

関連項目:

remove(java.lang.String)

put

Attribute put(Attribute attr)

属性セットに新しい属性を追加します。

パラメータ:

attr - 追加する null 以外の属性。属性セットがその属性 ID の大文字と小文字を無視する場合、attr の ID の大文字と小文字は無視される。

戻り値:

この属性セットに以前存在していた同じ attrID を持つ Attribute そのような属性が存在しなかった場合は null。

関連項目:

remove(java.lang.String)

remove

Attribute remove(String attrID)

属性セットから属性 ID「attrID」を持つ属性を削除します。この属性が存在しない場合は、無視されます。

パラメータ:

attrID - 削除する属性の null 以外の ID。属性セットが属性 ID の大文字と小文字を区別しない場合、attrID の大文字と小文字は区別されない。

戻り値:

この属性セットに以前存在していた attrID と同じ ID を持つ Attribute そのような属性が存在しなかった場合は null。

clone

Object clone()

属性セットのコピーを作成します。新しいセットには、元のセットと同じ属性が含まれます。この属性自体は複製されません。コピーに変更を加えても元の属性には影響ありません。また逆の場合も同じです。

戻り値:

この属性セットの null 以外のコピー。