モジュール java.xml
パッケージ org.xml.sax

インタフェースAttributes

既知のすべてのサブインタフェース:
Attributes2
既知のすべての実装クラス:
Attributes2Impl, AttributesImpl
public interface Attributes
XML属性のリストのためのインタフェースです。
このモジュールは、ソース・コード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。 詳細については、http://www.saxproject.orgを参照してください。

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

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

#IMPLIEDと宣言されていても開始タグ内に指定されていない属性は、リストには含まれません。 また、名前空間宣言(xmlns*)として使用される属性も、http://xml.org/sax/features/namespace-prefixes機能をtrueに設定しないかぎり含まれません(デフォルト値はfalse)。 SAX2は最初の「Namespaces in XML」勧告に従うため、通常は名前空間宣言属性に名前空間URIは与えられません。

SAX2パーサーによっては、オプションで機能フラグ(http://xml.org/sax/features/xmlns-uris)を使用してこれらの属性にURIが与えられるように要求できるものもあり、そのようなパーサーは下位互換性のないこの勧告の改訂版に適合しています。 (デフォルトによる要素名前空間を定義する場合の属性の「ローカル名」は接頭辞または「xmlns」)。 互換性に関しては、ハンドラ・コードが機能フラグの設定を変更できるパーサーを要求するのではなく、常にそのコンフリクトを解決するようにする必要があります。

名前空間接頭辞の機能(前述を参照)がfalseの場合、修飾名によってアクセスできない場合があります。http://xml.org/sax/features/namespaces機能がfalseの場合、名前空間修飾名によってアクセスできない場合があります。

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

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

導入されたバージョン:
1.4, SAX 2.0
関連項目:
AttributesImpl, DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    int getIndex​(String qName)
    XML修飾名(接頭辞付き)を指定して属性のインデックスを検索します。
    int getIndex​(String uri, String localName)
    名前空間名を指定して属性のインデックスを検索します。
    int getLength()
    リスト内にある属性の数を返します。
    String getLocalName​(int index)
    インデックスを指定して属性のローカル名を検索します。
    String getQName​(int index)
    インデックスを指定して属性のXML修飾名(接頭辞付き)を検索します。
    String getType​(int index)
    インデックスを指定して属性の型を検索します。
    String getType​(String qName)
    XML修飾名(接頭辞付き)を指定して属性の型を検索します。
    String getType​(String uri, String localName)
    名前空間名を指定して属性の型を検索します。
    String getURI​(int index)
    インデックスを指定して属性の名前空間URIを検索します。
    String getValue​(int index)
    インデックスを指定して属性の値を検索します。
    String getValue​(String qName)
    XML修飾名(接頭辞付き)を指定して属性の値を検索します。
    String getValue​(String uri, String localName)
    名前空間名を指定して属性の値を検索します。

  • メソッドの詳細

    • getLength

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

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

      戻り値:
      リスト内の属性の数。
      関連項目:
      getURI(int), getLocalName(int), getQName(int), getType(int), getValue(int)

    • getURI

      String getURI​(int index)
      インデックスを指定して属性の名前空間URIを検索します。
      パラメータ:
      index - 属性インデックス(ゼロから始まる)。
      戻り値:
      名前空間URI。使用可能な名前空間URIが存在しない場合は空文字列。インデックスが範囲外の場合はnull。
      関連項目:
      getLength()

    • getLocalName

      String getLocalName​(int index)
      インデックスを指定して属性のローカル名を検索します。
      パラメータ:
      index - 属性インデックス(ゼロから始まる)。
      戻り値:
      ローカル名。名前空間処理が実行されない場合は空文字列。インデックスが範囲外の場合はnull。
      関連項目:
      getLength()

    • getQName

      String getQName​(int index)
      インデックスを指定して属性のXML修飾名(接頭辞付き)を検索します。
      パラメータ:
      index - 属性インデックス(ゼロから始まる)。
      戻り値:
      XML修飾名。使用可能なXML修飾名が存在しない場合は空文字列。インデックスが範囲外の場合はnull。
      関連項目:
      getLength()

    • getType

      String getType​(int index)
      インデックスを指定して属性の型を検索します。

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

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

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

      パラメータ:
      index - 属性インデックス(ゼロから始まる)。
      戻り値:
      属性型を示す文字列。インデックスが範囲外の場合はnull。
      関連項目:
      getLength()

    • getValue

      String getValue​(int index)
      インデックスを指定して属性の値を検索します。

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

      パラメータ:
      index - 属性インデックス(ゼロから始まる)。
      戻り値:
      属性値を示す文字列。インデックスが範囲外の場合はnull。
      関連項目:
      getLength()

    • getIndex

      int getIndex​(String uri, String localName)
      名前空間名を指定して属性のインデックスを検索します。
      パラメータ:
      uri - 名前空間URI。名前が名前空間URIを持たない場合は空文字列。
      localName - 属性のローカル名。
      戻り値:
      属性インデックス。リスト内に存在しない場合は -1。

    • getIndex

      int getIndex​(String qName)
      XML修飾名(接頭辞付き)を指定して属性のインデックスを検索します。
      パラメータ:
      qName - 接頭辞付きの修飾名。
      戻り値:
      属性インデックス。リスト内に存在しない場合は -1。

    • getType

      String getType​(String uri, String localName)
      名前空間名を指定して属性の型を検索します。

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

      パラメータ:
      uri - 名前空間URI。名前が名前空間URIを持たない場合は空文字列。
      localName - 属性のローカル名。
      戻り値:
      属性型を示す文字列。属性がリスト内に存在しない場合、または名前空間処理が実行されない場合はnull。

    • getType

      String getType​(String qName)
      XML修飾名(接頭辞付き)を指定して属性の型を検索します。

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

      パラメータ:
      qName - XML修飾名。
      戻り値:
      属性型を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合はnull。

    • getValue

      String getValue​(String uri, String localName)
      名前空間名を指定して属性の値を検索します。

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

      パラメータ:
      uri - 名前空間URI。名前が名前空間URIを持たない場合は空文字列。
      localName - 属性のローカル名。
      戻り値:
      属性値を示す文字列。属性がリスト内に存在しない場合はnull。

    • getValue

      String getValue​(String qName)
      XML修飾名(接頭辞付き)を指定して属性の値を検索します。

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

      パラメータ:
      qName - XML修飾名。
      戻り値:
      属性値を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合はnull。