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

インタフェースParser

  • 既知のすべての実装クラス:
    XMLReaderAdapter

    @Deprecated(since="1.5")
    public interface Parser
    非推奨。
    このインタフェースは、名前空間サポートを含むSAX2 XMLReaderインタフェースで置き換えられています。
    SAX (Simple API for XML)パーサーの基本インタフェースです。
    このモジュールは、ソース・コード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません 詳細については、http://www.saxproject.orgを参照してください。

    SAX1のメインのイベント提供インタフェースでしたが、SAX2で、名前空間機能と高度な構成および拡張機能をサポートするXMLReaderに置き換えられました。

    すべてのSAX1パーサーは、この基本インタフェースを実装する必要があります。アプリケーションは、さまざまな型のイベント・ハンドラを登録する際や、URIまたは文字ストリームから構文解析を開始する際にこのインタフェースを使用します。

    すべてのSAX1パーサーは、引数なしのコンストラクタも実装しなければいけません(その他のコンストラクタも使用可能)。

    SAX1パーサーは再利用可能ですが、再入不可能です。つまり最初の構文解析が終了したら、アプリケーションはパーサー・オブジェクトを再利用できますが(別の入力ソースでの再利用も可能)、1回の構文解析でparse()メソッドを繰返し呼び出すことはできません。

    導入されたバージョン:
    1.4, SAX 1.0
    関連項目:
    EntityResolver, DTDHandler, DocumentHandler, ErrorHandler, HandlerBase, InputSource
    • メソッドの詳細

      • setLocale

        void setLocale​(Locale locale)
                throws SAXException
        非推奨。
        アプリケーションにエラーや警告のロケールの要求を許可します。

        SAXパーサーはエラーおよび警告のローカライズを義務付けられていません。しかし、要求されたロケールをサポートしていない場合はSAX例外をスローする必要があります。 構文解析中は、アプリケーションからロケールの変更を要求できません。

        パラメータ:
        locale - Java Localeオブジェクト。
        例外:
        SAXException - 要求されたロケールがサポートされていない場合、前のロケールまたはデフォルトのロケールを使って例外をスローする。
        関連項目:
        SAXException, SAXParseException
      • setEntityResolver

        void setEntityResolver​(EntityResolver resolver)
        非推奨。
        アプリケーションにカスタム・エンティティ・リゾルバの登録を許可します。

        アプリケーションがエンティティ・リゾルバを登録しないと、SAXパーサーはシステム識別子を解決し、エンティティ自体への接続を開始します(HandlerBaseのデフォルトの動作実装)。

        アプリケーションは、構文解析中も新しいエンティティ・リゾルバを登録できます。新しいリゾルバが登録されると、SAXパーサーはただちにこのリゾルバの使用を開始しなければいけません。

        パラメータ:
        resolver - エンティティを解決するためのオブジェクト。
        関連項目:
        EntityResolver, HandlerBase
      • setDTDHandler

        void setDTDHandler​(DTDHandler handler)
        非推奨。
        アプリケーションにDTDイベント・ハンドラの登録を許可します。

        アプリケーションがDTDハンドラを登録しないと、SAXパーサーが報告するすべてのDTDイベントは何の通知もなく無視されます(HandlerBaseのデフォルトの動作実装)。

        アプリケーションは、構文解析中も新しいハンドラを登録できます。新しいハンドラが登録されると、SAXパーサーはただちにこのハンドラの使用を開始しなければいけません。

        パラメータ:
        handler - DTDハンドラ。
        関連項目:
        DTDHandler, HandlerBase
      • setDocumentHandler

        void setDocumentHandler​(DocumentHandler handler)
        非推奨。
        アプリケーションに文書イベント・ハンドラの登録を許可します。

        アプリケーションが文書ハンドラを登録しないと、SAXパーサーが報告するすべての文書イベントは何の通知もなく無視されます(HandlerBaseのデフォルトの動作実装)。

        アプリケーションは、構文解析中も新しいハンドラを登録できます。新しいハンドラが登録されると、SAXパーサーはただちにこのハンドラの使用を開始しなければいけません。

        パラメータ:
        handler - 文書ハンドラ。
        関連項目:
        DocumentHandler, HandlerBase
      • setErrorHandler

        void setErrorHandler​(ErrorHandler handler)
        非推奨。
        アプリケーションにエラー・イベント・ハンドラの登録を許可します。

        アプリケーションがエラー・イベント・ハンドラを登録しないと、SAXパーサーが報告するエラー・イベントは何の通知もなく無視されます。ただし、fatalErrorだけは例外です。このエラー・イベントはSAXExceptionをスローします(HandlerBaseのデフォルトの動作実装)。

        アプリケーションは、構文解析中も新しいハンドラを登録できます。新しいハンドラが登録されると、SAXパーサーはただちにこのハンドラの使用を開始しなければいけません。

        パラメータ:
        handler - エラー・ハンドラ。
        関連項目:
        ErrorHandler, SAXException, HandlerBase
      • parse

        void parse​(InputSource source)
            throws SAXException,
                   IOException
        非推奨。
        XMLドキュメントを解析します。

        アプリケーションは、このメソッドを使って、有効な任意の入力ソース(文字ストリーム、バイト・ストリーム、またはURI)からXML文書の構文解析を開始するようにSAXパーサーに指示を送ります。

        構文解析中は、アプリケーションからこのメソッドを呼び出すことはできません。追加するXML文書がある場合はその1つ1つに新しいParserを作成する必要があります。 構文解析が完了したら、同じParserオブジェクトを再利用できます。別の入力ソースでの再利用も可能です。

        パラメータ:
        source - XML文書のトップ・レベルの入力ソース。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
        IOException - パーサーからのIO例外。アプリケーションが提供するバイト・ストリームまたは文字ストリームから発生する可能性があります。
        関連項目:
        InputSource, parse(java.lang.String), setEntityResolver(org.xml.sax.EntityResolver), setDTDHandler(org.xml.sax.DTDHandler), setDocumentHandler(org.xml.sax.DocumentHandler), setErrorHandler(org.xml.sax.ErrorHandler)
      • parse

        void parse​(String systemId)
            throws SAXException,
                   IOException
        非推奨。
        システム識別子(URI)からXML文書を構文解析します。

        このメソッドを使用すれば、システム識別子から簡単に文書を読み取ることができます。 次の指定でも同じことができます。

         parse(new InputSource(systemId));
         

        システム識別子がURLの場合、アプリケーションはこれをパーサーに渡す前に完全に解決する必要があります。

        パラメータ:
        systemId - システム識別子(URI)。
        例外:
        SAXException - 任意のSAX例外。ほかの例外をラップしている可能性があります。
        IOException - パーサーからのIO例外。アプリケーションが提供するバイト・ストリームまたは文字ストリームから発生する可能性があります。
        関連項目:
        parse(org.xml.sax.InputSource)