BasicAttribute (Java Platform SE 7)

java.lang.Object
- javax.naming.directory.BasicAttribute

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

Serializable, Cloneable, Attribute
```
public class BasicAttribute
extends Object
implements Attribute
```
このクラスは、Attribute インタフェースの基本的な実装を提供します。
この実装はスキーマメソッド getAttributeDefinition() および getAttributeSyntaxDefinition() をサポートしません。これらのメソッドはただ OperationNotSupportedException をスローします。BasicAttribute のサブクラスがこれらのメソッドをサポートしている場合、BasicAttribute がこれらのメソッドをオーバーライドします。
BasicAttribute クラスは、デフォルトでは、Object.equals() を使用して同一性のテスト時や値の検索時の属性値の同一性を判定しますが、値が配列である場合は例外です。配列の場合、配列の各要素は Object.equals() を使用してチェックされます。スキーマのこうした用法が有効なメソッドをオーバーライドすることによって同様の同一性チェックを行う場合、BasicAttribute のサブクラスがスキーマ情報を利用できます。同様に、BasicAttribute クラスはデフォルトでは、コンストラクタに渡された値または追加削除メソッドを使って処理された値、あるいはその両方を返します。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()
```
    次のクラスからコピーされた説明: 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、インタフェース: Attribute
    
    オーバーライド:
    
    clone、クラス: Object
    
    戻り値:
    このインスタンスの複製。
    関連項目:
    Cloneable
  - equals
```
public boolean equals(Object obj)
```
    obj がこの属性と同一かどうかを判別します。2 つの属性の属性 ID、構文、および値が等しい場合、2 つの属性は同一です。2 つの属性の値が順序付けされていない場合、値が追加された順序は関係ありません。属性値が順序付けされている場合、値の順序は一致する必要があります。obj が null であるか、または Attribute ではない場合、false が返されます。
    デフォルトでは、値が配列である場合を除き、Object.equals() を使用して属性 ID および属性の値を比較します。配列の場合、配列の各要素は Object.equals() を使用してチェックされます。サブクラスはこれをオーバーライドして、スキーマ構文情報、および 2 つの属性にとって同一が何を意味するかを定義する一致規則を使用できます。サブクラスがスキーマ情報を使用するかどうか、またどのように使用するかは、サブクラスが決定します。サブクラスが equals() をオーバーライドした場合、サブクラスは hashCode() もオーバーライドして、等しい 2 つの属性が同じハッシュコードを持つようにします。
    
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    obj - チェックする null の可能性があるオブジェクト。
    
    戻り値:
    obj がこの属性と等しい場合は true、そうでない場合は false。
    関連項目:
    hashCode(), contains(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    この属性のハッシュコードを計算します。
    ハッシュコードは、属性の ID のハッシュコード、および値が配列である場合を除く属性の値すべてのハッシュコードを加算することによって計算されます。配列の場合は、配列の各要素のハッシュコードが合計されます。サブクラスが hashCode() をオーバーライドした場合、サブクラスは equals() も同じようにオーバーライドして、等しい 2 つの属性が同じハッシュコードを持つようにします。
    
    オーバーライド:
    
    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
    
    属性値を属性値の順序付けられたリストに追加します。このメソッドは、インデックス ix にある属性値のリストに attrVal を追加します。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 - スキーマの取得中にネーミング例外が発生した場合。

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

クラス BasicAttribute

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

attrID

values

ordered

コンストラクタの詳細

BasicAttribute

BasicAttribute

BasicAttribute

BasicAttribute

メソッドの詳細

clone

equals

hashCode

toString

getAll

get

size

getID

contains

add

remove

clear

isOrdered

get

remove

add

set

getAttributeSyntaxDefinition

getAttributeDefinition