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。エラーはエラー・ハンドラに報告されているはずである。