パッケージ jakarta.xml.bind
クラス JAXB
- java.lang.ObjectSE
-
- jakarta.xml.bind.JAXB
public final class JAXB extends ObjectSE
Jakarta XML Binding の一般的で単純な使用のための便利なメソッドを定義するクラス。このクラスで定義されているメソッドは、
JAXBContext
、Unmarshaller
、Marshaller
のいくつかの基本操作を組み合わせた便利なメソッドです。これらは、Jakarta XML Binding を初めて使用する開発者にとって好ましいメソッドになるように設計されています。それらには次の特徴があります。- 一般的に、パフォーマンスは必ずしも最適ではありません。パフォーマンスが重要なコードを作成する必要がある人は、残りの Jakarta XML Binding API を直接使用することが期待されます。
- 処理中に発生するエラーは
DataBindingException
(JAXBException
をcause
として持つ) にラップされます。チェックされた例外を好む人は、残りの Jakarta XML Binding API を直接使用することが期待されます。
さらに、
unmarshal
メソッドには次の特徴があります。- 入力 XML に対してスキーマ検証は実行されません。XML にエラーがあっても、処理は可能な限り続行しようとします。最後の手段として、このメソッドは
DataBindingException
で失敗します。
同様に、
marshal
メソッドには次の特徴があります。- Java オブジェクトツリーが妥当性要件を満たしていない場合でも、処理は続行しようとします。最後の手段として、このメソッドは
DataBindingException
で失敗します。
このクラスのすべてのメソッドでは、すべてのパラメーターに null 以外の引数が必要です。
unmarshal
メソッドは、例外で失敗するか、null 以外の値を返します。- 導入:
- 1.6、JAXB 2.1
- 作成者:
- Kohsuke Kawaguchi
メソッドのサマリー
すべてのメソッド 静的メソッド 具象メソッド 修飾子と型 メソッド 説明 static void
marshal(ObjectSE jaxbObject, FileSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, OutputStreamSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, WriterSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, StringSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, URISE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, URLSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static void
marshal(ObjectSE jaxbObject, ResultSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。static <T> T
unmarshal(FileSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(InputStreamSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(ReaderSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(StringSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(URISE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(URLSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。static <T> T
unmarshal(SourceSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。
メソッドの詳細
unmarshal
public static <T> T unmarshal(FileSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- ファイル全体を XML として読み取ります。
unmarshal
public static <T> T unmarshal(URLSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- URL が指すリソース全体が読み取られます。
unmarshal
public static <T> T unmarshal(URISE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- URI はturned into URL
であり、その後はURL
の処理に従います。
unmarshal
public static <T> T unmarshal(StringSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- 文字列は最初に絶対URI
として解釈されます。a valid absolute URI
でない場合、File
として解釈されます
unmarshal
public static <T> T unmarshal(InputStreamSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- ストリーム全体が XML 情報セットとして読み取られます。正常に完了すると、ストリームはこのメソッドによって閉じられます。
unmarshal
public static <T> T unmarshal(ReaderSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
- 文字ストリームは XML 情報セットとして読み取られます。XML のエンコーディング宣言は無視されます。正常に完了すると、ストリームはこのメソッドによって閉じられます。
unmarshal
public static <T> T unmarshal(SourceSE xml, ClassSE<T> type)
指定された XML 入力から Java オブジェクトツリーを読み込みます。- パラメーター:
xml
-Source
SE が表す XML 情報セットが読み取られます。
marshal
public static void marshal(ObjectSE jaxbObject, FileSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- XML はこのファイルに書き込まれます。すでに存在する場合は上書きされます。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, URLSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- XML は、この URL が指すリソースへのsent
になります。すべてのURL
がそのような操作をサポートしているわけではなく、正確なセマンティクスはURL
の実装に依存することに注意してください。HTTP URLs
SE の場合、これは HTTP POST を実行します。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, URISE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- URI はturned into URL
であり、その後はURL
の処理に従います。上記を参照。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, StringSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- 文字列は最初に絶対URI
として解釈されます。a valid absolute URI
でない場合、File
として解釈されます- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, OutputStreamSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- XML は指定されたOutputStream
SE に送信されます。正常に完了すると、ストリームはこのメソッドによって閉じられます。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, WriterSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- XML は、指定されたWriter
SE に文字ストリームとして送信されます。正常に完了すると、ストリームはこのメソッドによって閉じられます。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。
marshal
public static void marshal(ObjectSE jaxbObject, ResultSE xml)
Java オブジェクトツリーを XML に書き込み、指定された場所に保存します。- パラメーター:
jaxbObject
- XML にマーシャリングされる Java オブジェクト。このオブジェクトがJAXBElement
の場合、ルートタグ名と本文が提供されます。このオブジェクトのクラス定義にXmlRootElement
がある場合、それがルートタグ名として使用され、指定されたオブジェクトが本体を提供します。それ以外の場合、ルートタグ名はthe short class name
から推測されます。このパラメーターは null であってはなりません。xml
- XML はResult
SE オブジェクトに送信されます。- 例外:
DataBindingException
- I/O エラーなどで操作が失敗した場合、バインドできないクラス。