- すべてのスーパー・インタフェース:
Cloneable,Serializable
- 既知のすべての実装クラス:
BasicAttribute
ディレクトリでは、指定されたオブジェクトはそれらの属性と関連付けることができます。 Attributeインタフェースは、名前付きオブジェクトに関連付けられた属性を表します。 属性には0以上の値が含まれ、値はnullの場合もあります。 属性値は、(isOrdered()を参照してください)の順序付けまたは順序付け解除が可能です。 値を順序付けていない場合は、複製は許可されません。 値を順序付けた場合は、複製が許可されます。
属性およびその値の内容と表現は、その属性のスキーマで定義されます。 スキーマには、属性の構文およびその属性に関するその他のプロパティについての情報が含まれています。 基礎となるディレクトリ・サービスがスキーマをサポートする場合の属性に関するスキーマ情報の取得方法の詳細は、getAttributeDefinition()およびgetAttributeSyntaxDefinition()を参照してください。
2つの属性が等しいかどうかは実装クラスによって判別されます。 単純な実装では、Object.equals()を使用して属性値の等価性を判断でき、より高度な実装では、スキーマ情報を使用して等価性を判断できます。 同様に、ある実装では、コンストラクタに渡される値を返す静的な記憶域構造が提供され、別の実装では、ディレクトリから動的に値を取得するためにget()およびgetAll()を定義する場合があります。
Attribute (値の追加や削除など)の更新は、ディレクトリ内の属性の対応する表現には影響しないことに注意してください。 ディレクトリの更新は、DirContextインタフェースの操作を使用してのみ変更できます。
- 導入されたバージョン:
- 1.3
- 関連項目:
-
フィールドのサマリー
フィールド -
メソッドのサマリー
修飾子と型メソッド説明void属性値を属性値の順序付けられたリストに追加します。boolean属性に新しい値を追加します。voidclear()この属性からすべての値を削除します。clone()属性のコピーを作成します。boolean値が属性内にあるかどうかを判別します。get()この属性の値の1つを検出します。get(int ix) 属性値の順序付けられたリストから属性値を取り出します。getAll()属性値の列挙を取り出します。属性のスキーマ定義を取り出します。属性に関連付けられている構文定義を取り出します。getID()この属性のIDを取り出します。boolean属性値が順序付けられているかどうかを判別します。remove(int ix) 属性値の順序付けられたリストから属性値を削除します。boolean指定された値を属性から削除します。属性値の順序付けられたリストの属性値を設定します。intsize()この属性の値数を取り出します。
-
フィールド詳細
-
serialVersionUID
@Deprecated static final long serialVersionUID非推奨。インタフェース内のserialVersionUIDフィールドは無効です。 使用しないでください; 代替なし。相互運用性のために、JNDI 1.1.1のserialVersionUIDを使用します。- 関連項目:
-
-
メソッドの詳細
-
getAll
NamingEnumeration<?> getAll() throws NamingException属性値の列挙を取り出します。 この列挙の動作は、列挙の進行中に属性の値を追加、変更、または削除する場合は保証されません。 属性値が順序付けられている場合は、列挙の項目も順序付けられます。- 戻り値:
- 属性値のnull以外の列挙。 列挙の各要素はnullオブジェクトの可能性がある。 オブジェクトのクラスは属性値のクラスである。 属性値がnullの場合は要素はnullになる。 属性にゼロ値が含まれる場合は空の列挙が返される。
- 例外:
NamingException- 値の取得中にネーミング例外が検出された場合。- 関連項目:
-
get
Object get() throws NamingExceptionこの属性の値の1つを検出します。 属性値が複数で、順序付けられていない場合は、それらの値のいずれか1つが返されます。 属性値が複数で順序付けられている場合は、最初の値が返されます。- 戻り値:
- nullの可能性がある、属性値の1つを表すオブジェクト。 属性値がnullの場合はnull。
- 例外:
NamingException- 値の取得中にネーミング例外が検出された場合。NoSuchElementException- この属性に値がない場合。
-
size
int size()この属性の値数を取り出します。- 戻り値:
- この属性の負でない値数。
-
getID
-
contains
boolean contains(Object attrVal) 値が属性内にあるかどうかを判別します。 等価性は実装によって決定されます。実装では、Object.equals()またはスキーマ情報を使用して等価性を判断できます。- パラメータ:
attrVal- チェックするnullの可能性がある値。 nullの場合、属性がnull値の属性値を持つかどうかを判定する。- 戻り値:
- attrValがこの属性値の1つである場合はtrue、そうでない場合はfalse。
- 関連項目:
-
add
boolean add(Object attrVal) 属性に新しい値を追加します。 属性値が順序付けされず、attrValがすでに属性内にある場合、このメソッドは何も行いません。 属性値が順序付けされている場合、属性値のリストの最後にattrValが追加されます。等価性は実装によって決定されます。実装では、
Object.equals()またはスキーマ情報を使用して等価性を判断できます。- パラメータ:
attrVal- 追加する新しいnullの可能性がある値。 nullの場合は、nullが属性値として追加されます。- 戻り値:
- 値が追加された場合はtrue、そうでない場合はfalse。
-
remove
boolean remove(Object attrval) 指定された値を属性から削除します。attrvalが属性に含まれていない場合、このメソッドは何も行いません。 属性値が順序付けされている場合は、最初に出現したattrValが削除され、削除された値より大きい索引の属性値がリスト(それらの指標は1つずつ減少)の先頭に向かってシフトされます。等価性は実装によって決定されます。実装では、
Object.equals()またはスキーマ情報を使用して等価性を判断できます。- パラメータ:
attrval- この属性から削除するnullの可能性がある値。 nullの場合、nullの属性値が削除される。- 戻り値:
- 値が削除された場合はtrue、そうでない場合はfalse。
-
clear
void clear()この属性からすべての値を削除します。 -
getAttributeSyntaxDefinition
DirContext getAttributeSyntaxDefinition() throws NamingException属性に関連付けられている構文定義を取り出します。 属性の構文定義では、1つ以上の属性値の形式を指定します。 これは、Javaオブジェクトとして属性値を表現する場合とは異なります。 構文定義は構文のディレクトリの概念を意味します。たとえば、値がJavaのStringオブジェクトであっても、そのディレクトリ構文は「Printable String」または「Telephone Number」となります。 あるいは、値がバイト配列の場合は、そのディレクトリ構文は「JPEG」または「Certificate」となります。 たとえば、属性の構文が「JPEG」の場合は、このメソッドは「JPEG」の構文定義を返します。
構文定義から取得できる情報は、ディレクトリに依存しています。
実装がスキーマをサポートしない場合は、OperationNotSupportedExceptionがスローされます。 実装がスキーマをサポートする場合は、このメソッドが定義されて適切な情報が返されます。
- 戻り値:
- 属性の構文定義。 実装がスキーマをサポートしても、この特定の属性にスキーマ情報が含まれていない場合はnull。
- 例外:
OperationNotSupportedException- スキーマの取得がサポートされていない場合。NamingException- スキーマの取得中にネーミング例外が発生した場合。
-
getAttributeDefinition
DirContext getAttributeDefinition() throws NamingException属性のスキーマ定義を取り出します。 属性のスキーマ定義には、属性の値は複数かまたは単一か、属性の値を比較するときに使用する一致規則などの情報が含まれます。 属性定義から取得できる情報は、ディレクトリに依存しています。実装がスキーマをサポートしない場合は、OperationNotSupportedExceptionがスローされます。 実装がスキーマをサポートする場合は、このメソッドが定義されて適切な情報が返されます。
- 戻り値:
- この属性のスキーマ定義。 実装がスキーマをサポートしても、この特定の属性にスキーマ情報が含まれていない場合はnull。
- 例外:
OperationNotSupportedException- スキーマの取得がサポートされていない場合。NamingException- スキーマの取得中にネーミング例外が発生した場合。
-
clone
Object clone()属性のコピーを作成します。 コピーには元の属性と同じ属性値が含まれます。属性値そのものは複製されません。 コピーに変更を加えても元の属性には影響ありません。また逆の場合も同じです。- 戻り値:
- この属性のnull以外のコピー。
-
isOrdered
boolean isOrdered()属性値が順序付けられているかどうかを判別します。 属性値が順序付けられている場合は、複製値が許可されます。 属性値が順序付けられていない場合は、値は任意の順序で表示され、複製値はありません。- 戻り値:
- この属性値が順序付けられている場合はtrue、そうでない場合はfalse。
- 関連項目:
-
get
属性値の順序付けられたリストから属性値を取り出します。 このメソッドは、属性値のリストのix索引の値を返します。 属性値が順序付けられていない場合、このメソッドはそのインデックスの位置にある値を返します。- パラメータ:
ix- 属性値の順序付けられたリスト内の値のインデックス。0 <= ix < size()。- 戻り値:
- 索引
ixでNULLの可能性がある属性値。属性値がnullの場合はnull。 - 例外:
NamingException- 値の取得中にネーミング例外が検出された場合。IndexOutOfBoundsException-ixが指定した範囲外の場合。
-
remove
Object remove(int ix) 属性値の順序付けられたリストから属性値を削除します。 このメソッドは、属性値のリストのix索引の値を削除します。 属性値が順序付けられていない場合は、このメソッドはそのインデックスにあった値を削除します。ixより大きいインデックスにある値は、リスト (それらの指標は1つずつ減少)の前方にシフトされます。- パラメータ:
ix- 削除する値のインデックス。0 <= ix < size()。- 戻り値:
- 削除された索引
ixの属性値がNULLである可能性があります。属性値がnullの場合はnullです。 - 例外:
IndexOutOfBoundsException-ixが指定した範囲外の場合。
-
add
void add(int ix, Object attrVal) 属性値を属性値の順序付けられたリストに追加します。 このメソッドは、attrValを索引ixの属性値のリストに追加します。ix以上の索引にある値は、リスト(インデックスが1ずつ増加)の最後にシフトされます。 属性値が順序付けされず、すでにattrValがある場合、IllegalStateExceptionがスローされます。- パラメータ:
ix- 新しい値を追加する属性値の順序付けられたリスト内のインデックス。0 <= ix <= size()。attrVal- 追加するnullの可能性がある属性値。nullの場合は、nullが値として追加される。- 例外:
IndexOutOfBoundsException-ixが指定した範囲外の場合。IllegalStateException- 属性値が順序付けされず、attrValがこれらの値のいずれかである場合。
-
set
属性値の順序付けられたリストの属性値を設定します。 このメソッドは、属性値のリストのix索引の値をattrValに設定します。 古い値は削除されます。 属性値が順序付けされていない場合、このメソッドは、attrValがすでにいずれかの値でないかぎり、その索引にある値にattrValを設定します。 その場合は、IllegalStateExceptionがスローされます。- パラメータ:
ix- 属性値の順序付けられたリスト内の値のインデックス。0 <= ix < size()。attrVal- 使用するnullの可能性がある属性値。 nullの場合、古い値がnullに変換される。- 戻り値:
- nullの可能性がある、置換されたインデックスixにある属性値。 属性値がnullの場合はnull。
- 例外:
IndexOutOfBoundsException-ixが指定した範囲外の場合。IllegalStateException-attrValがすでに存在し、属性値の順序が解除されている場合。
-
serialVersionUIDフィールドは無効です。