javax.xml.parsers
クラス 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 を使用してアプリケーションと通信する必要があるだけです。

DocumentBuilder の実装は、2 つ以上のスレッドで同時に使用された場合、仕様どおりに動作することは保証「されません」。スレッド当たり DocumentBuilder の 1 つのインスタンスにすることをお勧めします。複数のスレッドから DocumentBuilder が使用されるかどうかの確認はアプリケーションで行います。

導入されたバージョン:

JAXP 1.0

コンストラクタの概要

protected

DocumentBuilder()

メソッドの概要

abstract DOMImplementation	getDOMImplementation() DOMImplementation オブジェクトのインスタンスを取得します。
abstract boolean	isNamespaceAware() このパーサが名前空間を認識するように設定されているかどうかを示します。
abstract boolean	isValidating() このパーサが XML ドキュメントを検証するように設定されているかどうかを示します。
abstract Document	newDocument() DOM ツリーの構築に使用する DOM Document オブジェクトの新しいインスタンスを取得します。
Document	parse(File f) 指定されたファイルのコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。
abstract Document	parse(InputSource is) 指定された入力ソースのコンテンツを 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 void	setEntityResolver(EntityResolver er) 構文解析する XML ドキュメントに存在するエンティティを解決するのに使用される EntityResolver を指定します。
abstract void	setErrorHandler(ErrorHandler eh) 構文解析する XML ドキュメントに存在するエラーのレポートに使用される ErrorHandler を指定します。

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

DocumentBuilder

protected DocumentBuilder()

メソッドの詳細

parse

public Document parse(InputStream is)
               throws SAXException,
                      IOException

指定された InputStream のコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。

パラメータ:

is - 構文解析されるコンテンツを含む InputStream

例外:

IOException - 入出力エラーが発生した場合

SAXException - 構文解析エラーが発生した場合

IllegalArgumentException - InputStream が null の場合

関連項目:

DocumentHandler

parse

public Document parse(InputStream is,
                      String systemId)
               throws SAXException,
                      IOException

指定された InputStream のコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。

パラメータ:

is - 構文解析されるコンテンツを含む InputStream

systemId - 相対 URI を解決するためのベースを提供

戻り値:

新しい DOM Document オブジェクト

例外:

IOException - 入出力エラーが発生した場合

SAXException - 構文解析エラーが発生した場合

IllegalArgumentException - InputStream が null の場合

関連項目:

DocumentHandler

parse

public Document parse(String uri)
               throws SAXException,
                      IOException

指定された URI のコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。

パラメータ:

uri - 構文解析されるコンテンツの場所

戻り値:

新しい DOM Document オブジェクト

例外:

IOException - 入出力エラーが発生した場合

SAXException - 構文解析エラーが発生した場合

IllegalArgumentException - URI が null の場合

関連項目:

DocumentHandler

parse

public Document parse(File f)
               throws SAXException,
                      IOException

指定されたファイルのコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。

パラメータ:

f - 構文解析対象の XML を含むファイル

戻り値:

新しい DOM Document オブジェクト

例外:

IOException - 入出力エラーが発生した場合

SAXException - 構文解析エラーが発生した場合

IllegalArgumentException - ファイルが null の場合

関連項目:

DocumentHandler

parse

public abstract Document parse(InputSource is)
                        throws SAXException,
                               IOException

指定された入力ソースのコンテンツを XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。

パラメータ:

is - 構文解析されるコンテンツを含む InputSource

戻り値:

新しい DOM Document オブジェクト

例外:

IOException - 入出力エラーが発生した場合

SAXException - 構文解析エラーが発生した場合

IllegalArgumentException - InputSource が null の場合

関連項目:

DocumentHandler

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)

構文解析する XML ドキュメントに存在するエラーのレポートに使用される ErrorHandler を指定します。これを null に設定すると、デフォルトの実装が使用されます。

パラメータ:

eh - 構文解析する XML ドキュメントに存在するエラーのレポートに使用される ErrorHandler

newDocument

public abstract Document newDocument()

DOM ツリーの構築に使用する DOM Document オブジェクトの新しいインスタンスを取得します。DOM Document オブジェクトを作成する別の方法として、getDOMImplementation メソッドを使用して DOM Level2 DOMImplementation オブジェクトを取得し、次にそのオブジェクトの DOM Level2 メソッドを使用して作成する方法があります。

戻り値:

DOM Document オブジェクトの新しいインスタンス

getDOMImplementation

public abstract DOMImplementation getDOMImplementation()

DOMImplementation オブジェクトのインスタンスを取得します。

戻り値:

DOMImplementation の新しいインスタンス