BasicAttributes (Java Platform SE 7)

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(Attribute attr)` 属性セットに新しい属性を追加します。
`Attribute`	`put(String attrID, Object val)` 属性セットに新しい属性を追加します。
`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 の大文字と小文字は無視される。
    
    戻り値:
    この属性セットに以前存在していた同じ attrID を持つ 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)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス BasicAttributes

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

メソッドのサマリー

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

コンストラクタの詳細

BasicAttributes

BasicAttributes

BasicAttributes

BasicAttributes

メソッドの詳細

clone

isCaseIgnored

size

get

getAll

getIDs

put

put

remove

toString

equals

hashCode