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