javax.xml.bind.annotation

インタフェースDomHandler<ElementT,ResultT extends Result>

既知のすべての実装クラス:

W3CDomHandler

public interface DomHandler<ElementT,ResultT extends Result>

要素(とその子孫)をDOM (または類似)表現に、またはその逆方向に変換します。

XMLの要素をW3C DOMなどの情報セット表現にマップするために、このインタフェースの実装がXmlAnyElement注釈と組み合わせて使用されます。

XMLの一部をDOM式の表現に変換する方法やその逆方向の変換方法は実装側が非表示にするため、JAXBプロバイダはこうした任意のライブラリを扱うことができます。

このインタフェースは、ライブラリ作成者によって実装され、JAXBプロバイダによって使用されることを意図しています。これらのメソッドは、アプリケーションから呼び出されることを想定していません。

導入されたバージョン:

JAXB2.0

メソッドのサマリー

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

メソッドの詳細

createUnmarshaller

ResultT createUnmarshaller(ValidationEventHandler errorHandler)

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

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

パラメータ:

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

戻り値:

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

getElement

ElementT getElement(ResultT rt)

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

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

パラメータ:

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

戻り値:

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

marshal

Source marshal(ElementT n,
               ValidationEventHandler errorHandler)

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

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

パラメータ:

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

戻り値:

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