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

コンストラクタの概要

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 オブジェクトを返します。
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 オブジェクトを返します。
void	reset() この DocumentBuilder を元の設定にリセットします。
abstract void	setEntityResolver(EntityResolver er) 構文解析する XML ドキュメントに存在するエンティティーを解決するのに使用される EntityResolver を指定します。
abstract void	setErrorHandler(ErrorHandler eh) パーサーによって使用される ErrorHandler を指定します。

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

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

コンストラクタの詳細

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 の場合

関連項目:

DocumentHandler

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 の場合

関連項目:

DocumentHandler

parse

public Document parse(String uri)
               throws SAXException,
                      IOException

指定された URI の内容を XML ドキュメントとして解析し、新しい DOM Document オブジェクトを返します。URI が null の場合は IllegalArgumentException がスローされます。

パラメータ:

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

戻り値:

新しい DOM Document オブジェクト

例外:

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

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

IllegalArgumentException - uri が null の場合

関連項目:

DocumentHandler

parse

public Document parse(File f)
               throws SAXException,
                      IOException

指定されたファイルの内容を XML ドキュメントとして構文解析し、新しい DOM Document オブジェクトを返します。File が null の場合は IllegalArgumentException がスローされます。

パラメータ:

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

戻り値:

新しい DOM Document オブジェクト

例外:

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

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

IllegalArgumentException - f が null の場合

関連項目:

DocumentHandler

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 の場合

関連項目:

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)

パーサーによって使用される 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

関連項目:

DocumentBuilderFactory.setXIncludeAware(boolean)