クラスDefaultHandler

java.lang.Object
org.xml.sax.helpers.DefaultHandler
すべての実装されたインタフェース:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler
直系の既知のサブクラス:
DefaultHandler2
public class DefaultHandler extends Object implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler
SAX 2イベント・ハンドラのデフォルト基底クラスです。

このクラスは、SAX2アプリケーション用の簡易基底クラスです。SAX2の4つのコア・ハンドラ・クラスに含まれるすべてのコールバックのデフォルト実装を提供します。

アプリケーションの作成者は、インタフェースの一部だけを実装する必要があるとき、このクラスを拡張します。パーサーの作成者は、アプリケーション固有のデフォルト・ハンドラが提供されないとき、このクラスをインスタンス化してデフォルト・ハンドラを提供します。

このクラスは、非推奨に指定されているSAX1のHandlerBaseクラスに代わるクラスです。

導入されたバージョン:
1.4, SAX 2.0
関連項目:

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

    コンストラクタ
    コンストラクタ
    説明
    DefaultHandler()
    DefaultHandlerを構築します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    characters(char[] ch, int start, int length)
    要素内の文字データの通知を受け取ります。
    void
    endDocument()
    文書の終了通知を受け取ります。
    void
    endElement(String uri, String localName, String qName)
    要素の終了通知を受け取ります。
    void
    endPrefixMapping(String prefix)
    名前空間マッピングの終了通知を受け取ります。
    void
    error(SAXParseException e)
    回復可能なパーサー・エラーの通知を受け取ります。
    void
    fatalError(SAXParseException e)
    致命的なXML構文解析エラーを報告します。
    void
    ignorableWhitespace(char[] ch, int start, int length)
    要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。
    void
    notationDecl(String name, String publicId, String systemId)
    表記法宣言の通知を受け取ります。
    void
    processingInstruction(String target, String data)
    処理命令の通知を受け取ります。
    InputSource
    resolveEntity(String publicId, String systemId)
    外部エンティティを解決します。
    void
    setDocumentLocator(Locator locator)
    文書イベントのLocatorオブジェクトを受け取ります。
    void
    skippedEntity(String name)
    スキップされたエンティティの通知を受け取ります。
    void
    startDocument()
    文書の開始通知を受け取ります。
    void
    startElement(String uri, String localName, String qName, Attributes attributes)
    要素の開始通知を受け取ります。
    void
    startPrefixMapping(String prefix, String uri)
    名前空間マッピングの開始通知を受け取ります。
    void
    unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
    解析対象外エンティティ宣言の通知を受け取ります。
    void
    warning(SAXParseException e)
    パーサー警告の通知を受け取ります。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

    インタフェースで宣言されたメソッド ContentHandler

    declaration
    修飾子と型
    メソッド
    説明
    default void
    declaration(String version, String encoding, String standalone)
    XML宣言の通知を受け取ります。

  • コンストラクタの詳細

    • DefaultHandler

      public DefaultHandler()
      DefaultHandlerを構築します。

  • メソッドの詳細

    • resolveEntity

      public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException
      外部エンティティを解決します。

      常にnullを返します。これは、パーサーにXML文書内のシステム識別子を使用させるためです。 このメソッドはSAXのデフォルトの動作を実装します。アプリケーションの作成者は、サブクラス内でこれをオーバーライドし、カタログ検索やURIリダイレクションのような特殊な変換を行います。

      定義:
      resolveEntity、インタフェースEntityResolver
      パラメータ:
      publicId - 公開識別子。使用できない場合はnull。
      systemId - XML文書に含まれているシステム識別子。
      戻り値:
      新しい入力ソース。デフォルトの動作が必要な場合はnull。
      スロー:
      IOException - 新しい入力ソースの設定中にエラーが発生した場合。
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • notationDecl

      public void notationDecl(String name, String publicId, String systemId) throws SAXException
      表記法宣言の通知を受け取ります。

      デフォルトでは何も行いません。 文書内に宣言された表記法を追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

      定義:
      notationDecl、インタフェースDTDHandler
      パラメータ:
      name - 表記法名。
      publicId - 表記法の公開識別子。使用できない場合はnull。
      systemId - 表記法のシステム識別子。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • unparsedEntityDecl

      public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
      解析対象外エンティティ宣言の通知を受け取ります。

      デフォルトでは何も行いません。 文書内に宣言された解析対象外エンティティを追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

      定義:
      unparsedEntityDecl、インタフェースDTDHandler
      パラメータ:
      name - エンティティ名。
      publicId - エンティティの公開識別子。使用できない場合はnull。
      systemId - エンティティのシステム識別子。
      notationName - 関連表記法名。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • setDocumentLocator

      public void setDocumentLocator(Locator locator)
      文書イベントのLocatorオブジェクトを受け取ります。

      デフォルトでは何も行いません。 その他の文書イベントで使用するためにロケータを格納しておく必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。

      定義:
      setDocumentLocator、インタフェースContentHandler
      パラメータ:
      locator - すべてのSAX文書イベントのロケータ。
      関連項目:

    • startDocument

      public void startDocument() throws SAXException
      文書の開始通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、文書の先頭で特殊なアクション(ツリーのルート・ノードの割り当て、出力ファイルの作成など)を実行できます。

      定義:
      startDocument、インタフェースContentHandler
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • endDocument

      public void endDocument() throws SAXException
      文書の終了通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、文書の終わりで特殊なアクション(ツリーのファイナライズ、出力ファイルの終了など)を実行できます。

      定義:
      endDocument、インタフェースContentHandler
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • startPrefixMapping

      public void startPrefixMapping(String prefix, String uri) throws SAXException
      名前空間マッピングの開始通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各名前空間接頭辞のスコープの開始位置で特定のアクション(接頭辞のマッピングの格納など)を実行できます。

      定義:
      startPrefixMapping、インタフェースContentHandler
      パラメータ:
      prefix - 宣言される名前空間接頭辞。
      uri - 接頭辞にマッピングされた名前空間URI。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • endPrefixMapping

      public void endPrefixMapping(String prefix) throws SAXException
      名前空間マッピングの終了通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、個々の接頭辞の終了位置で特定のアクションを実行できます。

      定義:
      endPrefixMapping、インタフェースContentHandler
      パラメータ:
      prefix - 宣言される名前空間接頭辞。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • startElement

      public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
      要素の開始通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各要素の先頭で特殊なアクション(新しいツリー・ノードの割当て、出力内容のファイルへの書込みなど)を実行できます。

      定義:
      startElement、インタフェースContentHandler
      パラメータ:
      uri - 名前空間URI。要素が名前空間URIを持たない場合、または名前空間処理が実行されない場合は空文字列。
      localName - 接頭辞なしのローカル名。名前空間処理が実行されない場合は空文字列。
      qName - 接頭辞付きの修飾名。修飾名を使用できない場合は空文字列。
      attributes - 要素に付加された属性。 属性が存在しない場合、空のAttributesオブジェクト。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • endElement

      public void endElement(String uri, String localName, String qName) throws SAXException
      要素の終了通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各要素の終わりで特殊なアクション(ツリー・ノードのファイナライズ、出力内容のファイルへの書き込みなど)を実行できます。

      定義:
      endElement、インタフェースContentHandler
      パラメータ:
      uri - 名前空間URI。要素が名前空間URIを持たない場合、または名前空間処理が実行されない場合は空文字列。
      localName - 接頭辞なしのローカル名。名前空間処理が実行されない場合は空文字列。
      qName - 接頭辞付きの修飾名。修飾名を使用できない場合は空文字列。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • characters

      public void characters(char[] ch, int start, int length) throws SAXException
      要素内の文字データの通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、このメソッドをオーバーライドして、各文字データ・チャンクに対して特殊なアクション(ノードまたはバッファへのデータの追加、データのファイルへの出力など)を実行できます。

      定義:
      characters、インタフェースContentHandler
      パラメータ:
      ch - 文字。
      start - 文字配列内の開始位置。
      length - 文字配列から使用される文字数。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • ignorableWhitespace

      public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
      要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、このメソッドをオーバーライドして、無視できる空白文字の各チャンクに対して特殊なアクション(ノードまたはバッファへのデータの追加、データのファイルへの出力など)を実行できます。

      定義:
      ignorableWhitespace、インタフェースContentHandler
      パラメータ:
      ch - 空白文字。
      start - 文字配列内の開始位置。
      length - 文字配列から使用される文字数。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • processingInstruction

      public void processingInstruction(String target, String data) throws SAXException
      処理命令の通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション(ステータス変数の設定、その他のメソッドの呼び出しなど)を実行できます。

      定義:
      processingInstruction、インタフェースContentHandler
      パラメータ:
      target - 処理命令のターゲット。
      data - 処理命令データ。データが提供されない場合はnull。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • skippedEntity

      public void skippedEntity(String name) throws SAXException
      スキップされたエンティティの通知を受け取ります。

      デフォルトでは何も行いません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション(ステータス変数の設定、その他のメソッドの呼び出しなど)を実行できます。

      定義:
      skippedEntity、インタフェースContentHandler
      パラメータ:
      name - スキップされたエンティティの名前。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • warning

      public void warning(SAXParseException e) throws SAXException
      パーサー警告の通知を受け取ります。

      デフォルト実装は何も実行しません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各警告に対して特殊なアクション(ログ・ファイルへのメッセージの挿入、メッセージのコンソールへの出力など)を実行できます。

      定義:
      warning、インタフェースErrorHandler
      パラメータ:
      e - 例外としてエンコードされた警告情報。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • error

      public void error(SAXParseException e) throws SAXException
      回復可能なパーサー・エラーの通知を受け取ります。

      デフォルト実装は何も実行しません。 アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各エラーに対して特殊なアクション(ログ・ファイルへのメッセージの挿入、メッセージのコンソールへの出力など)を実行できます。

      定義:
      error、インタフェースErrorHandler
      パラメータ:
      e - 例外としてエンコードされたエラー情報。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目:

    • fatalError

      public void fatalError(SAXParseException e) throws SAXException
      致命的なXML構文解析エラーを報告します。

      デフォルトの実装ではSAXParseExceptionをスローします。 アプリケーションの作成者は、個々の致命的なエラーに対して特殊なアクションをとる(すべてのエラーを単一の報告にまとめるなど)必要がある場合、サブクラス内のこのメソッドをオーバーライドできます。このメソッドが呼び出されると、文書の信頼性が低くなり、パーサーも構文解析イベントを報告しなくなるので、アプリケーションの通常処理はすべて終了される必要があります。

      定義:
      fatalError、インタフェースErrorHandler
      パラメータ:
      e - 例外としてエンコードされたエラー情報。
      スロー:
      SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
      関連項目: