org.xml.sax.helpers
クラス AttributesImpl

java.lang.Object
  org.xml.sax.helpers.AttributesImpl

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

Attributes

直系の既知のサブクラス:

Attributes2Impl

public class AttributesImpl
extends Object
implements Attributes

Attributes インタフェースのデフォルト実装です。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。詳細については、http://www.saxproject.org を参照してください。

このクラスは、リストの変更や再利用を可能にするため、SAX2 Attributes インタフェースのデフォルト実装にマニプレータを追加します。

このクラスの典型的な用途は以下の 2 種類です。

1. startElement イベント内の Attributes オブジェクトの持続的なスナップショットを作成する
2. SAX2 ドライバまたはフィルタ内で Attributes オブジェクトを構築または変更する

このクラスは、現在では非推奨に指定されている SAX1 の AttributeListImpl クラスに代わるクラスです。非推奨の AttributeList インタフェースではなく更新された Attributes インタフェースをサポートします。また、Vectors のセットの代わりに単一の配列を使ってより効率的な実装を提供します。

導入されたバージョン:

SAX 2.0

コンストラクタの概要

AttributesImpl()
新しい空の AttributesImpl オブジェクトを作成します。

AttributesImpl(Attributes atts)
既存の Attributes オブジェクトをコピーします。

メソッドの概要

void	addAttribute(String uri, String localName, String qName, String type, String value) リストの末尾に属性を追加します。
void	clear() 再利用するため、属性リストを消去します。
int	getIndex(String qName) 修飾名 (前置修飾子付き) を指定して属性のインデックスを検索します。
int	getIndex(String uri, String localName) 名前空間名を指定して属性のインデックスを検索します。
int	getLength() リスト内にある属性の数を返します。
String	getLocalName(int index) 属性のローカル名を返します。
String	getQName(int index) 属性の修飾名 (前置修飾子付き) を返します。
String	getType(int index) インデックスを指定して属性の型を返します。
String	getType(String qName) 修飾名 (前置修飾子付き) を指定して属性の型を検索します。
String	getType(String uri, String localName) 名前空間修飾名を指定して属性の型を検索します。
String	getURI(int index) 属性の名前空間 URI を返します。
String	getValue(int index) インデックスを指定して属性の値を返します。
String	getValue(String qName) 修飾名 (前置修飾子付き) を指定して属性の値を検索します。
String	getValue(String uri, String localName) 名前空間修飾名を指定して属性の値を検索します。
void	removeAttribute(int index) リストから属性を削除します。
void	setAttribute(int index, String uri, String localName, String qName, String type, String value) リスト内の属性を設定します。
void	setAttributes(Attributes atts) Attributes オブジェクト全体をコピーします。
void	setLocalName(int index, String localName) 特定の属性のローカル名を設定します。
void	setQName(int index, String qName) 特定の属性の修飾名を設定します。
void	setType(int index, String type) 特定の属性の型を設定します。
void	setURI(int index, String uri) 特定の属性の名前空間 URI を設定します。
void	setValue(int index, String value) 特定の属性の値を設定します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AttributesImpl

public AttributesImpl()

新しい空の AttributesImpl オブジェクトを作成します。

AttributesImpl

public AttributesImpl(Attributes atts)

既存の Attributes オブジェクトをコピーします。

このコンストラクタは、特に startElement イベント内で役に立ちます。

パラメータ:

atts - 既存の Attributes オブジェクト

メソッドの詳細

getLength

public int getLength()

リスト内にある属性の数を返します。

定義:

インタフェース Attributes 内の getLength

戻り値:

リスト内の属性の数

関連項目:

Attributes.getLength()

getURI

public String getURI(int index)

属性の名前空間 URI を返します。

定義:

インタフェース Attributes 内の getURI

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

名前空間 URI。使用可能な名前空間 URI が存在しない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

Attributes.getURI(int)

getLocalName

public String getLocalName(int index)

属性のローカル名を返します。

定義:

インタフェース Attributes 内の getLocalName

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性のローカル名。使用可能なローカル名が存在しない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

Attributes.getLocalName(int)

getQName

public String getQName(int index)

属性の修飾名 (前置修飾子付き) を返します。

定義:

インタフェース Attributes 内の getQName

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性の修飾名。使用可能な修飾名が存在しない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

Attributes.getQName(int)

getType

public String getType(int index)

インデックスを指定して属性の型を返します。

定義:

インタフェース Attributes 内の getType

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性の型。不明な場合は「CDATA」、インデックスが範囲外の場合は null

関連項目:

Attributes.getType(int)

getValue

public String getValue(int index)

インデックスを指定して属性の値を返します。

定義:

インタフェース Attributes 内の getValue

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性値。インデックスが範囲外の場合は null

関連項目:

Attributes.getValue(int)

getIndex

public int getIndex(String uri,
                    String localName)

名前空間名を指定して属性のインデックスを検索します。

通常は、名前の照会メソッドを繰り返し使用するよりも、名前を 1 回だけ検索して、あとはインデックス照会メソッドを使用するほうが効率的です。

定義:

インタフェース Attributes 内の getIndex

パラメータ:

uri - 属性の名前空間 URI。使用可能な名前空間が存在しない場合は空文字列

localName - 属性のローカル名

戻り値:

属性のインデックス。一致するものがない場合は -1

関連項目:

Attributes.getIndex(java.lang.String,java.lang.String)

getIndex

public int getIndex(String qName)

修飾名 (前置修飾子付き) を指定して属性のインデックスを検索します。

定義:

インタフェース Attributes 内の getIndex

パラメータ:

qName - 修飾名

戻り値:

属性のインデックス。一致するものがない場合は -1

関連項目:

Attributes.getIndex(java.lang.String)

getType

public String getType(String uri,
                      String localName)

名前空間修飾名を指定して属性の型を検索します。

定義:

インタフェース Attributes 内の getType

パラメータ:

uri - 名前空間 URI。名前が明示的な名前空間 URI を持たない場合は空文字列

localName - ローカル名

戻り値:

属性の型。一致する属性が存在しない場合は null

関連項目:

Attributes.getType(java.lang.String,java.lang.String)

getType

public String getType(String qName)

修飾名 (前置修飾子付き) を指定して属性の型を検索します。

定義:

インタフェース Attributes 内の getType

パラメータ:

qName - 修飾名

戻り値:

属性の型。一致する属性が存在しない場合は null

関連項目:

Attributes.getType(java.lang.String)

getValue

public String getValue(String uri,
                       String localName)

名前空間修飾名を指定して属性の値を検索します。

定義:

インタフェース Attributes 内の getValue

パラメータ:

uri - 名前空間 URI。名前が明示的な名前空間 URI を持たない場合は空文字列

localName - ローカル名

戻り値:

属性値。一致する属性が存在しない場合は null

関連項目:

Attributes.getValue(java.lang.String,java.lang.String)

getValue

public String getValue(String qName)

修飾名 (前置修飾子付き) を指定して属性の値を検索します。

定義:

インタフェース Attributes 内の getValue

パラメータ:

qName - 修飾名

戻り値:

属性値。一致する属性が存在しない場合は null

関連項目:

Attributes.getValue(java.lang.String)

clear

public void clear()

再利用するため、属性リストを消去します。

この呼び出しによって解放されるメモリはごくわずかです。現在の配列がそのまま再利用されます。

setAttributes

public void setAttributes(Attributes atts)

Attributes オブジェクト全体をコピーします。

常に新しいオブジェクトを割り当てるよりも、既存のオブジェクトを再利用するほうが効率がよくなる可能性があります。

パラメータ:

atts - コピーする属性

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String qName,
                         String type,
                         String value)

リストの末尾に属性を追加します。

処理の高速化のため、このメソッドは、その属性がリスト内にすでに存在するかどうかを確認しません。この確認処理はアプリケーションで行う必要があります。

パラメータ:

uri - 名前空間 URI。使用可能な名前空間 URI が存在しない場合や、名前空間処理が実行されていない場合は空文字列

localName - ローカル名。名前空間処理が行われていない場合は空文字列

qName - 前置修飾子を持つ修飾名。修飾名を使用できない場合は空文字列

type - 属性型を示す文字列

value - 属性値

setAttribute

public void setAttribute(int index,
                         String uri,
                         String localName,
                         String qName,
                         String type,
                         String value)

リスト内の属性を設定します。

処理の高速化のため、このメソッドは、名前が競合しないかどうか、正しい形式であるかどうかを確認しません。この確認処理はアプリケーションによって行う必要があります。

パラメータ:

index - 属性インデックス (ゼロから始まる)

uri - 名前空間 URI。使用可能な名前空間 URI が存在しない場合や、名前空間処理が実行されていない場合は空文字列

localName - ローカル名。名前空間処理が行われていない場合は空文字列

qName - 修飾名。修飾名を使用できない場合は空文字列

type - 属性型を示す文字列

value - 属性値

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

removeAttribute

public void removeAttribute(int index)

リストから属性を削除します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

setURI

public void setURI(int index,
                   String uri)

特定の属性の名前空間 URI を設定します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

uri - 属性の名前空間 URI。使用可能な名前空間が存在しない場合は空文字列

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

setLocalName

public void setLocalName(int index,
                         String localName)

特定の属性のローカル名を設定します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

localName - 属性のローカル名。使用可能なローカル名が存在しない場合は空文字列

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

setQName

public void setQName(int index,
                     String qName)

特定の属性の修飾名を設定します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

qName - 属性の修飾名。使用可能な修飾名が存在しない場合は空文字列

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

setType

public void setType(int index,
                    String type)

特定の属性の型を設定します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

type - 属性の型

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合

setValue

public void setValue(int index,
                     String value)

特定の属性の値を設定します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

value - 属性の値

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスがリスト内の属性をポイントしない場合