パッケージ jakarta.xml.bind.annotation

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

  • すべての既知の実装クラス:
    W3CDomHandler
    public interface DomHandler<ElementT,​ResultT extends ResultSE>
    要素（およびその子孫）を DOM（または同様の）表現との間で変換します。

    このインターフェースの実装は、XmlAnyElement アノテーションと組み合わせて使用され、XML の要素を W3CDOM などの情報セットの表現にマップします。

    実装は、XML の一部がそのような DOM のような表現にどのように変換されるかを隠し、Jakarta XML Binding プロバイダーがそのような任意のライブラリを操作できるようにします。

    このインターフェースは、ライブラリ作成者によって実装され、Jakarta XML Binding プロバイダーによって使用されることを目的としています。これらのメソッドはいずれも、アプリケーションから呼び出すことを目的としたものではありません。

    導入:
    1.6、JAXB 2.0
    作成者:
    Kohsuke Kawaguchi

    • メソッドの詳細

      • createUnmarshaller

        ResultT createUnmarshaller​(ValidationEventHandler errorHandler)
        Jakarta XML Binding プロバイダーは、ドキュメントの一部を情報セット表現にアンマーシャリングする必要がある場合、最初にこのメソッドを呼び出して ResultSE オブジェクトを作成します。

        次に、Jakarta XML Binding プロバイダーは、XML の一部を指定された結果に送信します。このような部分は常に、要素をルートとする XML ドキュメント全体のサブツリーを形成します。

        パラメーター:
        errorHandler - このメソッドの呼び出しと getElement(Result) の呼び出しの間にエラーが発生した場合は、このハンドラーに報告する必要があります。呼び出し元は、null 以外のエラーハンドラーを提供する必要があります。このメソッドから作成された ResultSE オブジェクトは、このエラーハンドラーへの参照を保持している可能性があります。
        戻り値:
        操作が失敗した場合は null。エラーはエラーハンドラーに報告されている必要があります。

      • getElement

        ElementT getElement​(ResultT rt)
        部分が ResultSE に送信されたら。このメソッドは、マーシャリングされていない要素表現を取得するために Jakarta XML Binding プロバイダーによって呼び出されます。

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

        パラメーター:
        rt - createUnmarshaller(ValidationEventHandler) によって作成された ResultSE オブジェクト。
        戻り値:
        操作が失敗した場合は null。エラーはエラーハンドラーに報告されている必要があります。

      • marshal

        SourceSE marshal​(ElementT n,
               ValidationEventHandler errorHandler)
        このメソッドは、Jakarta XML Binding プロバイダーが要素を XML にマーシャリングする必要がある場合に呼び出されます。

        null 以外の場合、返される SourceSE には、1 つの要素をルートとするドキュメント全体が含まれている必要があります。このドキュメントは、Jakarta XML Binding プロバイダーがマーシャリングしているより大きなドキュメントに織り込まれます。

        パラメーター:
        errorHandler - 要素を SourceSE に変換するプロセス中に発生したエラーを受け取ります。呼び出し元は、null 以外のエラーハンドラーを提供する必要があります。
        戻り値:
        エラーがあった場合は null。エラーはハンドラーに報告されているはずです。