モジュール java.naming

パッケージ javax.naming.directory

クラスBasicAttributes

java.lang.Object

javax.naming.directory.BasicAttributes

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

Serializable, Cloneable, Attributes

public class BasicAttributes
extends Object
implements Attributes

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

BasicAttributesは、大文字と小文字の区別ありと、大文字と小文字の区別なしのどちらかになります。 このプロパティは、BasicAttributesコンストラクタが呼び出された時点で決定されます。 大文字と小文字の区別をしないBasicAttributesの場合は、属性の検索または属性の追加の際に、属性識別子の大文字と小文字は区別されません。 大文字と小文字の区別をするBasicAttributesの場合は、大文字と小文字は区別されます。

BasicAttributesクラスがAttributeを作成する必要がある場合、BasicAttributeを使用します。 BasicAttributeに依存しているものはほかにありません。

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

BasicAttributesインスタンスは、並行マルチスレッド・アクセスに対して同期化されません。 単一のBasicAttributesインスタンスをアクセスおよび変更しようとする複数のスレッドによって、オブジェクトはロックされます。

導入されたバージョン:

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()	Attributesのインスタンスを新しく構築します。
BasicAttributes(boolean ignoreCase)	Attributesのインスタンスを新しく構築します。
BasicAttributes(String attrID, Object val)	Attributesのインスタンスを1つの属性で新しく構築します。
BasicAttributes(String attrID, Object val, boolean ignoreCase)	Attributesのインスタンスを1つの属性で新しく構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
Object	clone()	このオブジェクトのコピーを作成して、返します。
boolean	equals(Object obj)	このBasicAttributesが別のAttributesに等しいかどうかを判定します。2つのAttributesが等しいのは、その両方がAttributesのインスタンスであり、属性IDの大文字と小文字を同じ方法で扱い、さらに同じ属性を含んでいる場合です。
Attribute	get(String attrID)	属性セットから、指定された属性IDを持つ属性を取り込みます。
NamingEnumeration<Attribute>	getAll()	属性セットの属性の列挙を取り出します。
NamingEnumeration<String>	getIDs()	属性セットの属性IDの列挙を取り出します。
int	hashCode()	このBasicAttributesのハッシュ・コードを計算します。
boolean	isCaseIgnored()	属性の取り込みまたは追加をしているときに、属性セットが属性識別子の大文字と小文字を無視するかどうかを判別します。
Attribute	put(String attrID, Object val)	属性セットに新しい属性を追加します。
Attribute	put(Attribute attr)	属性セットに新しい属性を追加します。
Attribute	remove(String attrID)	属性セットから属性ID「attrID」を持つ属性を削除します。
int	size()	属性セットの属性数を取り込みます。
String	toString()	この属性セットの文字列表記を生成します。

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

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

コンストラクタの詳細

BasicAttributes

public BasicAttributes()

Attributesのインスタンスを新しく構築します。 以降属性を検索または追加する際に、属性識別子の大文字と小文字は区別されます。

BasicAttributes

public BasicAttributes(boolean ignoreCase)

Attributesのインスタンスを新しく構築します。 ignoreCaseがtrueの場合、属性識別子の大文字と小文字は無視されます。それ以外の場合は、大文字と小文字は意味を持ちます。

パラメータ:

ignoreCase - trueは、属性を取得または追加するときに、この属性セットがその属性識別子の大文字と小文字を無視することを示す。falseは大文字と小文字に従うことを示す。

BasicAttributes

public BasicAttributes(String attrID,
                       Object val)

Attributesのインスタンスを1つの属性で新しく構築します。 属性IDおよびvalによって指定された属性が、新しく作成された属性に追加されます。 以降属性を検索または追加する際に、属性識別子の大文字と小文字は区別されます。

パラメータ:

attrID - 追加する属性のnull以外のID。

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

BasicAttributes

public BasicAttributes(String attrID,
                       Object val,
                       boolean ignoreCase)

Attributesのインスタンスを1つの属性で新しく構築します。 属性IDおよびvalによって指定された属性が、新しく作成された属性に追加されます。 ignoreCaseがtrueの場合、属性識別子の大文字と小文字は無視されます。それ以外の場合は、大文字と小文字は意味を持ちます。

パラメータ:

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

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

ignoreCase - trueは、属性を取得または追加するときに、この属性セットがその属性識別子の大文字と小文字を無視することを示す。falseは大文字と小文字に従うことを示す。

メソッドの詳細

clone

public Object clone()

次のクラスからコピーされた説明: Object

このオブジェクトのコピーを作成して、返します。 「コピー」の正確な意味合いは、オブジェクトのクラスによって異なります。 一般的な意図は、任意のオブジェクトxについて、次の式

 x.clone() != x

がtrueであり、次の式

 x.clone().getClass() == x.getClass()

がtrueになることですが、これらは絶対的な要件ではありません。 また次の式

 x.clone().equals(x)

がtrueになりますが、これは絶対的な要件ではありません。

慣例上、返されたオブジェクトは、super.cloneを呼び出すことによって取得するようにしてください。 クラスとそのすべてのスーパー・クラス(Objectを除く)がこの規則に従っている場合は、x.clone().getClass()== x.getClass()が成立します。

通常、このメソッドにより返されるオブジェクトは、このオブジェクト(複製されている)から独立している必要があります。 この独立性を実現するには、super.cloneによって返されたオブジェクトを返す前に、その1つ以上のフィールドを変更することが必要になる場合があります。 これは、通常、複製するオブジェクトの内部「深層構造」を構成する可変オブジェクトのコピー、およびこれらのオブジェクトへの参照をコピーへの参照に置き換えることを意味します。 クラスにプリミティブ・フィールドまたは不変オブジェクトへの参照しか含まれていない場合は、通常、super.cloneによって返されたオブジェクト内のフィールドを変更する必要がありません。

クラスObjectのメソッドcloneは、特定のクローニング操作を実行します。 まず、このオブジェクトのクラスがインタフェースCloneableを実装していない場合は、CloneNotSupportedExceptionがスローされます。 すべての配列がインタフェースCloneableを実装していると見なされること、および配列型T[]のcloneメソッドの戻り値の型はT[] (ここで、Tは任意の参照またはプリミティブ型)です。 そうでない場合、このメソッドはこのオブジェクトのクラスの新しいインスタンスを生成し、そのフィールドをすべて、このオブジェクトの対応する各フィールドの内容で初期化します。これは代入と同様で、フィールドの内容自身が複製されるのではありません。 つまりこのメソッドは、オブジェクトの「シャロー・コピー」を生成しますが、「ディープ・コピー」は生成しません。

クラスObject自体はインタフェースCloneableを実装していないため、クラスがObjectであるオブジェクトに対してcloneメソッドを呼び出すと、実行時に例外がスローされます。

定義:

clone、インタフェース: Attributes

オーバーライド:

clone、クラス: Object

戻り値:

このインスタンスの複製。

関連項目:

Cloneable

isCaseIgnored

public boolean isCaseIgnored()

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

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

定義:

isCaseIgnored、インタフェース: Attributes

戻り値:

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

size

public int size()

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

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

定義:

size、インタフェース: Attributes

戻り値:

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

get

public Attribute get(String attrID)

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

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

定義:

get、インタフェース: Attributes

パラメータ:

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

戻り値:

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

関連項目:

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

getAll

public NamingEnumeration<Attribute> getAll()

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

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

定義:

getAll、インタフェース: Attributes

戻り値:

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

getIDs

public NamingEnumeration<String> getIDs()

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

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

定義:

getIDs、インタフェース: Attributes

戻り値:

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

put

public Attribute put(String attrID,
                     Object val)

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

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

定義:

put、インタフェース: Attributes

パラメータ:

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

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

戻り値:

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

関連項目:

Attributes.remove(java.lang.String)

put

public Attribute put(Attribute attr)

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

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

定義:

put、インタフェース: Attributes

パラメータ:

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

戻り値:

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

関連項目:

Attributes.remove(java.lang.String)

remove

public Attribute remove(String attrID)

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

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

定義:

remove、インタフェース: Attributes

パラメータ:

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

戻り値:

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

toString

public String toString()

この属性セットの文字列表記を生成します。 文字列は、各属性識別子および各属性の内容によって構成されます。 この文字列の内容はデバッグに有効で、プログラムでは解釈されません。

オーバーライド:

toString、クラス: Object

戻り値:

この属性セットの内容を示す、null以外の文字列表記。

equals

public boolean equals(Object obj)

このBasicAttributesが別のAttributesに等しいかどうかを判定します。2つのAttributesが等しいのは、その両方がAttributesのインスタンスであり、属性IDの大文字と小文字を同じ方法で扱い、さらに同じ属性を含んでいる場合です。 このBasicAttributesの各Attributeが同一かどうかはObject.equals()を使用して判定されます。Object.equals()はAttributeの実装によってオーバーライドされていることがあります。 サブクラスがequals()をオーバーライドした場合、サブクラスはhashCode()も同じようにオーバーライドして、等しい2つのAttributesインスタンスが同じハッシュ・コードを持つようにします。

オーバーライド:

equals、クラス: Object

パラメータ:

obj - 比較対象となるnullの可能性があるオブジェクト。

戻り値:

objがこのBasicAttributesと等しい場合はtrue。

関連項目:

hashCode()

hashCode

public int hashCode()

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

ハッシュ・コードは、このオブジェクトの属性のハッシュ・コードを加算することによって計算されます。 このBasicAttributesが属性IDの大文字と小文字を区別しない場合はハッシュ・コードに1が加算されます。 サブクラスがhashCode()をオーバーライドした場合、サブクラスはequals()も同じようにオーバーライドして、等しい2つのAttributesインスタンスが同じハッシュ・コードを持つようにします。

オーバーライド:

hashCode、クラス: Object

戻り値:

このBasicAttributesインスタンスのハッシュ・コードを表すint。

関連項目:

equals(java.lang.Object)