javax.xml.bind.annotation

クラス W3CDomHandler

java.lang.Object

javax.xml.bind.annotation.W3CDomHandler

すべての実装されたインタフェース:

DomHandler<Element,DOMResult>

public class W3CDomHandler
extends Object
implements DomHandler<Element,DOMResult>

W3C DOM (org.w3c.dom パッケージ) 用の DomHandler 実装。

導入されたバージョン:

JAXB2.0

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

コンストラクタ

コンストラクタと説明
W3CDomHandler() デフォルトのコンストラクタです。
W3CDomHandler(DocumentBuilder builder) 使用する DOM 実装をアプリケーションが指定できるコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
DOMResult	createUnmarshaller(ValidationEventHandler errorHandler) ドキュメントの一部を情報セット表現に非整列化する必要がある場合、JAXB プロバイダは最初にこのメソッドを呼び出して Result オブジェクトを作成します。
DocumentBuilder	getBuilder()
Element	getElement(DOMResult r) 一部が Result に一度送信されます。
Source	marshal(Element element, ValidationEventHandler errorHandler) JAXB プロバイダが要素を XML に整列化する必要がある場合、このメソッドは呼び出されます。
void	setBuilder(DocumentBuilder builder)

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

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

コンストラクタの詳細

W3CDomHandler

public W3CDomHandler()

デフォルトのコンストラクタです。 使用する DOM 実装や設定方法についての決定は、JAXB プロバイダに委ねられます。

W3CDomHandler

public W3CDomHandler(DocumentBuilder builder)

使用する DOM 実装をアプリケーションが指定できるコンストラクタです。

パラメータ:

builder - null は不可。JAXB はこの DocumentBuilder を使用して新しい要素を作成する。

メソッドの詳細

getBuilder

public DocumentBuilder getBuilder()

setBuilder

public void setBuilder(DocumentBuilder builder)

createUnmarshaller

public DOMResult createUnmarshaller(ValidationEventHandler errorHandler)

インタフェースからコピーされた説明: DomHandler

ドキュメントの一部を情報セット表現に非整列化する必要がある場合、JAXB プロバイダは最初にこのメソッドを呼び出して Result オブジェクトを作成します。

その後、JAXB プロバイダは XML の一部を、与えられた結果内に送信します。こうした XML の一部は常に、ある要素をルートとする XML 文書全体のサブツリーを形成します。

定義:

createUnmarshaller、インタフェース: DomHandler<Element,DOMResult>

パラメータ:

errorHandler - このメソッドの呼び出しと DomHandler.getElement(Result) の呼び出しの間にエラーが発生した場合、エラーがこのハンドラに報告される必要がある。 呼び出し側は、null でないエラーハンドラを提供する必要があります。 このメソッドから作成された Result オブジェクトがこのエラーハンドラへの参照を保持する場合があります。

戻り値:

処理が失敗した場合、null。エラーはエラーハンドラに報告されている必要がある。

getElement

public Element getElement(DOMResult r)

インタフェースからコピーされた説明: DomHandler

一部が Result に一度送信されます。このメソッドは、非整列化された要素表現を取得するために JAXB プロバイダによって呼び出されます。

このメソッドを複数回呼び出した場合、異なるオブジェクトが返される可能性があります。このメソッドは、サブツリー全体が Result オブジェクトに送られた場合のみ呼び出すことができます。

定義:

getElement、インタフェース: DomHandler<Element,DOMResult>

パラメータ:

r - DomHandler.createUnmarshaller(ValidationEventHandler) によって作成された Result オブジェクト。

戻り値:

処理が失敗した場合、null。エラーはエラーハンドラに報告されている必要がある。

marshal

public Source marshal(Element element,
             ValidationEventHandler errorHandler)

インタフェースからコピーされた説明: DomHandler

JAXB プロバイダが要素を XML に整列化する必要がある場合、このメソッドは呼び出されます。

戻り値の Source が null 以外の場合、ある要素をルートとするドキュメント全体を含んでいる必要があり、あとにそれは JAXB プロバイダが整列化するより大きなドキュメント内に組み込まれます。

定義:

marshal、インタフェース: DomHandler<Element,DOMResult>

errorHandler - 要素を Source に変換している途中で発生したエラーを受け取る。 呼び出し側は、null でないエラーハンドラを提供する必要があります。

戻り値:

エラーが発生した場合、null。エラーはエラーハンドラに報告されているはずである。