- java.lang.Object
-
- javax.xml.bind.JAXB
-
public final class JAXB extends Object
JAXBを通常、簡単に使用するための簡易メソッドを定義するクラスです。このクラスで定義されるメソッドは、
JAXBContext
、Unmarshaller
、およびMarshaller
のいくつかの基本オペレーションが組み合わされた簡易メソッドです。 これらのメソッドは、JAXBを使い始めたばかりの開発者に最適なメソッドとなるように設計されています。 次の特徴があります。- 一般に、性能は必ずしも最適とは限りません。 性能が重視されるコードを記述する必要のあるユーザーは残りのJAXB APIを直接使用するものと想定されています。
- 処理中に発生するエラーは、(
JAXBException
がそのcause
となる)DataBindingException
にラップされます。 チェック例外を好むユーザーは残りのJAXB APIを直接使用するものと想定されています。
また、
unmarshal
メソッドには次の特徴があります。- 入力XMLではスキーマ検証が行われません。 XMLにエラーがある場合でも、できるだけ処理を続行させます。 最後の手段としてのみ、このメソッドは
DataBindingException
を生成して失敗します。
同様に、
marshal
メソッドには次の特徴があります。- Javaオブジェクト・ツリーが妥当性の要件を満たさない場合でも、処理を続行させます。 最後の手段としてのみ、このメソッドは
DataBindingException
を生成して失敗します。
このクラスのすべてのメソッドでは、すべてのパラメータにnull以外の引数が必要です。
unmarshal
メソッドは例外を生成して失敗するか、null以外の値を返します。- 導入されたバージョン:
- 1.6, JAXB 2.1
-
-
メソッドのサマリー
すべてのメソッド staticメソッド 具象メソッド 修飾子と型 メソッド 説明 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オブジェクト・ツリーを読み込みます。
-
-
-
メソッドの詳細
-
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
- 入出力エラーやバインド不可のクラスなどのために、操作が失敗した場合。
-
-