モジュール java.xml.bind

パッケージ javax.xml.bind

クラスJAXB

java.lang.Object

javax.xml.bind.JAXB

public final class JAXB
extends Object

JAXBを通常、簡単に使用するための簡易メソッドを定義するクラスです。

このクラスで定義されるメソッドは、JAXBContext、Unmarshaller、およびMarshallerのいくつかの基本オペレーションが組み合わされた簡易メソッドです。 これらのメソッドは、JAXBを使い始めたばかりの開発者に最適なメソッドとなるように設計されています。 次の特徴があります。

1. 一般に、性能は必ずしも最適とは限りません。 性能が重視されるコードを記述する必要のあるユーザーは残りのJAXB APIを直接使用するものと想定されています。
2. 処理中に発生するエラーは、(JAXBExceptionがそのcauseとなる) DataBindingExceptionにラップされます。 チェック例外を好むユーザーは残りのJAXB APIを直接使用するものと想定されています。

また、unmarshalメソッドには次の特徴があります。

1. 入力XMLではスキーマ検証が行われません。 XMLにエラーがある場合でも、できるだけ処理を続行させます。 最後の手段としてのみ、このメソッドはDataBindingExceptionを生成して失敗します。

同様に、marshalメソッドには次の特徴があります。

1. Javaオブジェクト・ツリーが妥当性の要件を満たさない場合でも、処理を続行させます。 最後の手段としてのみ、このメソッドはDataBindingExceptionを生成して失敗します。

このクラスのすべてのメソッドでは、すべてのパラメータにnull以外の引数が必要です。 unmarshalメソッドは例外を生成して失敗するか、null以外の値を返します。

導入されたバージョン:

1.6, JAXB 2.1

メソッドのサマリー

修飾子と型	メソッド	説明
static void	marshal(Object jaxbObject, File xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, OutputStream xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, Writer xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, String xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, URI xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, URL xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static void	marshal(Object jaxbObject, Result xml)	Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。
static <T> T	unmarshal(File xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(InputStream xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(Reader xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(String xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(URI xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(URL xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。
static <T> T	unmarshal(Source xml, Class<T> type)	指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

クラス java.lang.Objectで宣言されたメソッド

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

メソッドの詳細

unmarshal

public static <T> T unmarshal(File xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - ファイル全体がXMLとして読み込まれる。

unmarshal

public static <T> T unmarshal(URL xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - URLで示されるリソース全体が読み込まれる。

unmarshal

public static <T> T unmarshal(URI xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - URIがturned into URL、そのあとでURLの処理が実行される。

unmarshal

public static <T> T unmarshal(String xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - 文字列は、最初に絶対URIと解釈される。 a valid absolute URIでない場合は、Fileと解釈される

unmarshal

public static <T> T unmarshal(InputStream xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - ストリーム全体がXML情報セットとして読み込まれる。 正常に完了した時点で、このメソッドによってストリームが閉じられる。

unmarshal

public static <T> T unmarshal(Reader xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - 文字ストリームがXML情報セットとして読み込まれる。 XMLのエンコーディング宣言は無視される。 正常に完了した時点で、このメソッドによってストリームが閉じられる。

unmarshal

public static <T> T unmarshal(Source xml,
                              Class<T> type)

指定されたXML入力からJavaオブジェクト・ツリーを読み込みます。

パラメータ:

xml - Sourceで示されるXML情報セットが読み込まれる。

marshal

public static void marshal(Object jaxbObject,
                           File xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - XMLはこのファイルに書き込まれる。 すでに存在する場合は上書きされる。

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           URL xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - XMLはこのURLで示されるソースにsentされる。 すべてのURLがそのようなオペレーションをサポートするとは限らず、正確なセマンティックスはURLの実装によって異なる。 HTTP URLsの場合は、HTTP POSTを実行する。

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           URI xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - URIがturned into URL、そのあとでURLの処理が実行される。 (上述を参照)

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           String xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - 文字列は、最初に絶対URIと解釈される。 a valid absolute URIでない場合は、Fileと解釈される

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           OutputStream xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - XMLは指定されたOutputStreamに送信される。 正常に完了した時点で、このメソッドによってストリームが閉じられる。

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           Writer xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - XMLは指定されたWriterに文字ストリームとして送信される。 正常に完了した時点で、このメソッドによってストリームが閉じられる。

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。

marshal

public static void marshal(Object jaxbObject,
                           Result xml)

Javaオブジェクト・ツリーをXMLに書き込み、指定された場所に格納します。

パラメータ:

jaxbObject - XMLに整列化するJavaオブジェクト。 このオブジェクトがJAXBElementの場合は、それがルート・タグ名と本体を提供する。 このオブジェクトのクラス定義にXmlRootElementが含まれている場合は、それがルート・タグ名として使用され、指定されたオブジェクトが本体を提供する。 それ以外の場合は、ルート・タグ名はinferedからthe short class name。 このパラメータはnullであってはならない。

xml - XMLはResultオブジェクトに送信される。

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。