org.xml.sax
インタフェース Attributes

既知の実装クラスの一覧:

AttributesImpl

public interface Attributes

XML 属性のリストのためのインタフェースです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。

このインタフェースは、3 通りの方法で属性リストへのアクセスを提供します。

1. 属性インデックスを使用する方法
2. 名前空間修飾名を使用する方法
3. 前置修飾子付きの修飾名を使用する方法

#IMPLIED と宣言されているが開始タグ内に指定されていない属性は、リストには含まれません。また、名前空間宣言 (xmlns*) として使用される属性も、http://xml.org/sax/features/namespace-prefixes 機能の値を true に設定しないかぎりリストには含まれません (デフォルト値は false)。

名前空間修飾機能 (上記を参照) が false に設定されている場合、修飾名を指定してアクセスすることはできません。http://xml.org/sax/features/namespaces 機能の値が false に設定されている場合、名前空間修飾名を指定してアクセスすることはできません。

このインタフェースは現在は非推奨に指定されている SAX1 の AttributeList インタフェースに代わるインタフェースです。このインタフェースには、SAX1 の AttributeList インタフェースではサポートされていなかった名前空間機能のほか、以下の getIndex メソッドが追加されています。

リスト内の属性の順序は未指定であり、実装ごとに異なります。

導入されたバージョン:

SAX 2.0

関連項目:

AttributeListImpl

メソッドの概要

int	getIndex(String qName) XML 1.0 修飾名を指定して属性のインデックスを検索します。
int	getIndex(String uri, String localPart) 名前空間名を指定して属性のインデックスを検索します。
int	getLength() リスト内にある属性の数を返します。
String	getLocalName(int index) インデックスを指定して属性のローカル名を検索します。
String	getQName(int index) インデックスを指定して属性の XML 1.0 修飾名を検索します。
String	getType(int index) インデックスを指定して属性の型を検索します。
String	getType(String qName) XML 1.0 修飾名を指定して属性の型を検索します。
String	getType(String uri, String localName) 名前空間名を指定して属性の型を検索します。
String	getURI(int index) インデックスを指定して属性の名前空間 URI を検索します。
String	getValue(int index) インデックスを指定して属性の値を検索します。
String	getValue(String qName) XML 1.0 修飾名を指定して属性の値を検索します。
String	getValue(String uri, String localName) 名前空間名を指定して属性の値を検索します。

メソッドの詳細

getLength

public int getLength()

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

属性の数が特定されたら、このリストで繰り返し処理を行うことができます。

戻り値:

リスト内の属性の数

関連項目:

getURI(int), getLocalName(int), getQName(int), getType(int), getValue(int)

getURI

public String getURI(int index)

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

パラメータ:

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

戻り値:

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

関連項目:

getLength()

getLocalName

public String getLocalName(int index)

インデックスを指定して属性のローカル名を検索します。

パラメータ:

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

戻り値:

ローカル名。名前空間処理が実行されない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getQName

public String getQName(int index)

インデックスを指定して属性の XML 1.0 修飾名を検索します。

パラメータ:

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

戻り値:

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

関連項目:

getLength()

getType

public String getType(int index)

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

属性型は、文字列 "CDATA"、"ID"、"IDREF"、"IDREFS"、"NMTOKEN"、"NMTOKENS"、"ENTITY"、"ENTITIES"、"NOTATION" のいずれかの型になります (常に大文字を使用)。

パーサが属性の宣言を読み取らず、属性型を報告しない場合、XML 1.0 勧告 (3.3.3「属性値の正規化」) に従って、値 "CDATA" が返されます。

表記法以外の列挙型属性の型は "NMTOKEN" と報告されます。

パラメータ:

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

戻り値:

属性型を示す文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getValue

public String getValue(int index)

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

属性値が IDREFS、ENTITIES、NMTOKENS のいずれかのトークンのリストである場合、トークンは空白文字で区切られた単一の文字列に連結されます。

パラメータ:

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

戻り値:

属性値を示す文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getIndex

public int getIndex(String uri,
                    String localPart)

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

パラメータ:

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

戻り値:

属性インデックス。リスト内に存在しない場合は -1

getIndex

public int getIndex(String qName)

XML 1.0 修飾名を指定して属性のインデックスを検索します。

パラメータ:

qName - 前置修飾子付きの修飾名

戻り値:

属性インデックス。リスト内に存在しない場合は -1

getType

public String getType(String uri,
                      String localName)

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

使用可能な型については、getType(int) の説明を参照してください。

パラメータ:

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

localName - 属性のローカル名

戻り値:

属性型を示す文字列。属性がリスト内に存在しない場合、または名前空間処理が実行されない場合は null

getType

public String getType(String qName)

XML 1.0 修飾名を指定して属性の型を検索します。

使用可能な型については、getType(int) の説明を参照してください。

パラメータ:

qName - XML 1.0 修飾名

戻り値:

属性型を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合は null

getValue

public String getValue(String uri,
                       String localName)

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

使用可能な値については、getValue(int) の説明を参照してください。

パラメータ:

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

localName - 属性のローカル名

戻り値:

属性値を示す文字列。属性がリスト内に存在しない場合は null

getValue

public String getValue(String qName)

XML 1.0 修飾名を指定して属性の値を検索します。

使用可能な値については、getValue(int) の説明を参照してください。

パラメータ:

qName - XML 1.0 修飾名

戻り値:

属性値を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合は null