クラスDocumentBuilder

java.lang.Object
javax.xml.parsers.DocumentBuilder
public abstract class DocumentBuilder extends Object
XMLドキュメントからDOM Documentインスタンスを取得するAPIを定義します。 このクラスを使用すると、アプリケーション・プログラマはXMLからDocumentを取得できます。

このクラスのインスタンスはDocumentBuilderFactory.newDocumentBuilder()メソッドにより取得できます。 このクラスのインスタンスを取得すると、さまざまな入力ソースからXMLドキュメントを構文解析できます。 これらの入力ソースには、InputStream、File、URL、およびSAX InputSourceがあります。

このクラスはSAX APIのいくつかのクラスを再利用します。 この場合、基本となるDOM実装の実装側がSAXパーサーを使用してXMLドキュメントをDocumentに構文解析する必要はありません。 実装がこれらの既存のAPIを使用してアプリケーションと通信する必要があるだけです。

導入されたバージョン:
1.4

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

    コンストラクタ
    修飾子
    コンストラクタ
    説明
    protected
    DocumentBuilder()
    protectedコンストラクタです。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    abstract DOMImplementation
    getDOMImplementation()
    DOMImplementationオブジェクトのインスタンスを取得します。
    Schema
    getSchema()
    XMLプロセッサによって使用されているSchemaへの参照を取得します。
    abstract boolean
    isNamespaceAware()
    このパーサーが名前空間を認識するように構成されているかどうかを示します。
    abstract boolean
    isValidating()
    このパーサーがXMLドキュメントを検証するように構成されているかどうかを示します。
    boolean
    isXIncludeAware()
    このパーサーのXInclude処理モードを取得します。
    abstract Document
    newDocument()
    DOMツリーの構築に使用するDOM Documentオブジェクトの新しいインスタンスを取得します。
    Document
    parse(File f)
    指定されたファイルの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。
    Document
    parse(InputStream is)
    指定されたInputStreamの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。
    Document
    parse(InputStream is, String systemId)
    指定されたInputStreamの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。
    Document
    parse(String uri)
    指定されたURIの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。
    abstract Document
    parse(InputSource is)
    指定された入力ソースの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。
    void
    reset()
    このDocumentBuilderを元の構成にリセットします。
    abstract void
    setEntityResolver(EntityResolver er)
    構文解析するXMLドキュメントに存在するエンティティを解決するのに使用されるEntityResolverを指定します。
    abstract void
    setErrorHandler(ErrorHandler eh)
    パーサーによって使用されるErrorHandlerを指定します。

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

    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であるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • DocumentBuilder

      protected DocumentBuilder()
      protectedコンストラクタです。

  • メソッドの詳細

    • reset

      public void reset()

      このDocumentBuilderを元の構成にリセットします。

      DocumentBuilderは、DocumentBuilderFactory.newDocumentBuilder()で作成された時点の状態にリセットされます。reset()は、既存のDocumentBuilderの再使用を許可するように設計されているため、新しいDocumentBuilderの作成に関連するリソースを節約できます。

      DocumentBuilderをリセットした場合、同じEntityResolverまたはErrorHandler Object (たとえば、Object.equals(Object obj))を持つことは保証されません。 機能的に同じEntityResolverおよびErrorHandlerを持つことは保証されます。

      スロー:
      UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合。
      導入されたバージョン:
      1.5

    • parse

      public Document parse(InputStream is) throws SAXException, IOException
      指定されたInputStreamの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。 InputStreamがnullの場合はIllegalArgumentExceptionがスローされます。
      パラメータ:
      is - 構文解析されるコンテンツを含むInputStream。
      戻り値:
      InputStreamの構文解析結果のDocument
      スロー:
      IOException - 入出力エラーが発生した場合。
      SAXException - 構文解析エラーが発生した場合。
      IllegalArgumentException - isがnullの場合
      関連項目:

    • parse

      public Document parse(InputStream is, String systemId) throws SAXException, IOException
      指定されたInputStreamの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。 InputStreamがnullの場合はIllegalArgumentExceptionがスローされます。
      パラメータ:
      is - 構文解析されるコンテンツを含むInputStream。
      systemId - 相対URIを解決するためのベースを提供。
      戻り値:
      新しいDOM Documentオブジェクト。
      スロー:
      IOException - 入出力エラーが発生した場合。
      SAXException - 構文解析エラーが発生した場合。
      IllegalArgumentException - isがnullの場合
      関連項目:

    • parse

      public Document parse(String uri) throws SAXException, IOException
      指定されたURIの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。 URIがnullの場合、IllegalArgumentExceptionがスローされます。
      パラメータ:
      uri - 構文解析されるコンテンツの場所。
      戻り値:
      新しいDOM Documentオブジェクト。
      スロー:
      IOException - 入出力エラーが発生した場合。
      SAXException - 構文解析エラーが発生した場合。
      IllegalArgumentException - uriがnullの場合
      関連項目:

    • parse

      public Document parse(File f) throws SAXException, IOException
      指定されたファイルの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。 Fileがnullの場合、IllegalArgumentExceptionがスローされます。
      パラメータ:
      f - 構文解析対象のXMLを含むファイル。
      戻り値:
      新しいDOM Documentオブジェクト。
      スロー:
      IOException - 入出力エラーが発生した場合。
      SAXException - 構文解析エラーが発生した場合。
      IllegalArgumentException - fがnullの場合
      関連項目:

    • parse

      public abstract Document parse(InputSource is) throws SAXException, IOException
      指定された入力ソースの内容をXMLドキュメントとして構文解析し、新しいDOM Documentオブジェクトを返します。 InputSourceがnullの場合、IllegalArgumentExceptionがスローされます。
      パラメータ:
      is - 構文解析されるコンテンツを含むInputSource。
      戻り値:
      新しいDOM Documentオブジェクト。
      スロー:
      IOException - 入出力エラーが発生した場合。
      SAXException - 構文解析エラーが発生した場合。
      IllegalArgumentException - isがnullの場合
      関連項目:

    • isNamespaceAware

      public abstract boolean isNamespaceAware()
      このパーサーが名前空間を認識するように構成されているかどうかを示します。
      戻り値:
      このパーサーが名前空間を認識するように構成されている場合はtrue、そうでない場合はfalse。

    • isValidating

      public abstract boolean isValidating()
      このパーサーがXMLドキュメントを検証するように構成されているかどうかを示します。
      戻り値:
      このパーサーがXMLドキュメントを検証するように構成されている場合はtrue、そうでない場合はfalse。

    • setEntityResolver

      public abstract void setEntityResolver(EntityResolver er)
      構文解析するXMLドキュメントに存在するエンティティを解決するのに使用されるEntityResolverを指定します。 これをnullに設定すると、デフォルトの実装と動作を使用した基本となる実装になります。
      パラメータ:
      er - 構文解析するXMLドキュメントに存在するエンティティの解決のために使用されるEntityResolver。

    • setErrorHandler

      public abstract void setErrorHandler(ErrorHandler eh)
      パーサーによって使用されるErrorHandlerを指定します。 これをnullに設定すると、デフォルトの実装と動作を使用した基本となる実装になります。
      パラメータ:
      eh - パーサーによって使用されるErrorHandler。

    • newDocument

      public abstract Document newDocument()
      DOMツリーの構築に使用するDOM Documentオブジェクトの新しいインスタンスを取得します。
      戻り値:
      DOM Documentオブジェクトの新しいインスタンス。

    • getDOMImplementation

      public abstract DOMImplementation getDOMImplementation()
      DOMImplementationオブジェクトのインスタンスを取得します。
      戻り値:
      DOMImplementationの新しいインスタンス。

    • getSchema

      public Schema getSchema()

      XMLプロセッサによって使用されているSchemaへの参照を取得します。

      スキーマを使用していない場合はnullが返されます。

      戻り値:
      使用されているSchemaまたは使用されていない場合はnull
      スロー:
      UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合
      導入されたバージョン:
      1.5

    • isXIncludeAware

      public boolean isXIncludeAware()

      このパーサーのXInclude処理モードを取得します。

      戻り値:
      このパーサーがファクトリから作成されたときにDocumentBuilderFactory.isXIncludeAware()から返される値。
      スロー:
      UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合
      導入されたバージョン:
      1.5
      関連項目: