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. 処理中に発生するエラーは、DataBindingException (JAXBException をその cause として持つ) にラップされます。確認済み例外を好むユーザーは残りの JAXB API を直接使用するものと見られています。

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

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

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

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

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

導入されたバージョン:

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, Result 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, Writer 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(Source 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 オブジェクトツリーを読み込みます。

クラス 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 が URL に変換され、そのあとで URL の処理が実行される

unmarshal

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

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

パラメータ:

xml - 文字列は、最初に絶対 URI と解釈される。有効な絶対 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 が含まれている場合は、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供する。そうでない場合、ルートタグ名は短いクラス名から推測される。このパラメータは null であってはならない

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           URL xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           URI xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           String xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           OutputStream xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           Writer xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合

marshal

public static void marshal(Object jaxbObject,
                           Result xml)

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

パラメータ:

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

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

例外:

DataBindingException - 入出力エラーやバインド不可のクラスなどのために、オペレーションが失敗した場合