javax.xml.bind.helpers
クラス AbstractMarshallerImpl

java.lang.Object
  javax.xml.bind.helpers.AbstractMarshallerImpl

すべての実装されたインタフェース:

Marshaller

public abstract class AbstractMarshallerImpl
extends Object
implements Marshaller

部分的なデフォルト Marshaller 実装です。

このクラスは、Marshaller インタフェースの部分的なデフォルト実装を提供します。

JAXB プロバイダが実装する必要があるメソッドは、marshal(Object, javax.xml.transform.Result)、marshal(Object, javax.xml.stream.XMLStreamWriter)、および marshal(Object, javax.xml.stream.XMLEventWriter) のみです。

導入されたバージョン:

JAXB1.0

関連項目:

Marshaller

入れ子のクラスの概要

インタフェース javax.xml.bind.Marshaller から継承された入れ子のクラス/インタフェース

Marshaller.Listener

フィールドの概要

インタフェース javax.xml.bind.Marshaller から継承されたフィールド

JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

コンストラクタの概要

AbstractMarshallerImpl()

メソッドの概要

<A extends XmlAdapter> A	getAdapter(Class<A> type) 指定した型に関連付けられているアダプタを取得します。
AttachmentMarshaller	getAttachmentMarshaller()
protected String	getEncoding() 現在の出力エンコーディングを取得するための簡易メソッドです。
ValidationEventHandler	getEventHandler() 現在のイベントハンドラ、または、それが設定されていない場合はデフォルトイベントハンドラを返します。
protected String	getJavaEncoding(String encoding) IANA 名から対応する Java エンコーディング名を取得します。
Marshaller.Listener	getListener() この Marshaller に登録されている Marshaller.Listener を返します。
Node	getNode(Object obj) デフォルトでは、getNode メソッドはサポートされず、UnsupportedOperationException をスローします。
protected String	getNoNSSchemaLocation() 現在の noNamespaceSchemaLocation を取得するための簡易メソッドです。
Object	getProperty(String name) getProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。
Schema	getSchema() 整列化時の検証に使用される JAXP 1.3 Schema オブジェクトを取得します。
protected String	getSchemaLocation() 現在の schemaLocation を取得するための簡易メソッドです。
protected boolean	isFormattedOutput() 書式設定された出力フラグを取得するための簡易メソッドです。
protected boolean	isFragment() フラグメントフラグを取得するための簡易メソッドです。
void	marshal(Object obj, ContentHandler handler) jaxbElement をルートとするコンテンツツリーを SAX2 イベントに整列化します。
void	marshal(Object obj, Node node) jaxbElement をルートとするコンテンツツリーを DOM ツリーに整列化します。
void	marshal(Object obj, OutputStream os) jaxbElement をルートとするコンテンツツリーを出力ストリームに整列化します。
void	marshal(Object obj, Writer w) jaxbElement をルートとするコンテンツツリーを Writer に整列化します。
void	marshal(Object obj, XMLEventWriter writer) jaxbElement をルートとするコンテンツツリーを XMLEventWriter に整列化します。
void	marshal(Object obj, XMLStreamWriter writer) jaxbElement をルートとするコンテンツツリーを XMLStreamWriter に整列化します。
<A extends XmlAdapter> void	setAdapter(Class<A> type, A adapter) XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。
void	setAdapter(XmlAdapter adapter) XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。
void	setAttachmentMarshaller(AttachmentMarshaller am) XML 文書内のバイナリデータを、XML バイナリの最適化された添付として転送可能にするコンテキストを関連付けます。
protected void	setEncoding(String encoding) 出力エンコーディングを設定するための簡易メソッドです。
void	setEventHandler(ValidationEventHandler handler) アプリケーションが検証イベントハンドラを登録することができます。
protected void	setFormattedOutput(boolean v) 書式設定された出力フラグを設定するための簡易メソッドです。
protected void	setFragment(boolean v) フラグメントフラグを設定するための簡易メソッドです。
void	setListener(Marshaller.Listener listener) この Marshaller に整列化イベントコールバック Marshaller.Listener を登録します。
protected void	setNoNSSchemaLocation(String location) noNamespaceSchemaLocation を設定するための簡易メソッドです。
void	setProperty(String name, Object value) setProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。
void	setSchema(Schema schema) 後の整列化操作の検証に使用する、JAXP 1.3 Schema オブジェクトを指定します。
protected void	setSchemaLocation(String location) schemaLocation を設定するための簡易メソッドです。

クラス java.lang.Object から継承されたメソッド

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

インタフェース javax.xml.bind.Marshaller から継承されたメソッド

marshal

コンストラクタの詳細

AbstractMarshallerImpl

public AbstractMarshallerImpl()

メソッドの詳細

marshal

public final void marshal(Object obj,
                          OutputStream os)
                   throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを出力ストリームに整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化するコンテンツツリーのルート

os - XML はこのストリームに追加される

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が obj (または、 obj から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

marshal

public final void marshal(Object obj,
                          Writer w)
                   throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを Writer に整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化するコンテンツツリーのルート

w - XML はこのライターに送信される

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が obj (または、 obj から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

marshal

public final void marshal(Object obj,
                          ContentHandler handler)
                   throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを SAX2 イベントに整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化するコンテンツツリーのルート

handler - XML はこのハンドラに SAX2 イベントとして送信される

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が obj (または、 obj から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

marshal

public final void marshal(Object obj,
                          Node node)
                   throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを DOM ツリーに整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化するコンテンツツリー

node - DOM ノードがこのノードの子として追加される。 このパラメータは、子 (Document、 DocumentFragment、または Element) を受け入れるノードでなくてはならない

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が jaxbElement (または、 jaxbElement から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

getNode

public Node getNode(Object obj)
             throws JAXBException

デフォルトでは、getNode メソッドはサポートされず、UnsupportedOperationException をスローします。 このメソッドをサポートすることを選択した実装は、このメソッドをオーバーライドする必要があります。

定義:

インタフェース Marshaller 内の getNode

パラメータ:

obj - - XML コンテンツの JAXB Java 表現

戻り値:

コンテンツツリーの DOM ツリービュー

例外:

JAXBException - 予想外の問題が発生した場合

getEncoding

protected String getEncoding()

現在の出力エンコーディングを取得するための簡易メソッドです。

戻り値:

現在のエンコーディング、または、設定されていない場合は「UTF-8」

setEncoding

protected void setEncoding(String encoding)

出力エンコーディングを設定するための簡易メソッドです。

パラメータ:

encoding - Marshaller クラス文書で指定された有効なエンコーディング

getSchemaLocation

protected String getSchemaLocation()

現在の schemaLocation を取得するための簡易メソッドです。

戻り値:

現在の schemaLocation、または、設定されていない場合は null

setSchemaLocation

protected void setSchemaLocation(String location)

schemaLocation を設定するための簡易メソッドです。

パラメータ:

location - schemaLocation 値

getNoNSSchemaLocation

protected String getNoNSSchemaLocation()

現在の noNamespaceSchemaLocation を取得するための簡易メソッドです。

戻り値:

現在の noNamespaceSchemaLocation、または、設定されていない場合は null

setNoNSSchemaLocation

protected void setNoNSSchemaLocation(String location)

noNamespaceSchemaLocation を設定するための簡易メソッドです。

パラメータ:

location - noNamespaceSchemaLocation 値

isFormattedOutput

protected boolean isFormattedOutput()

書式設定された出力フラグを取得するための簡易メソッドです。

戻り値:

書式設定された出力フラグの現在の値、または、設定されていない場合は false

setFormattedOutput

protected void setFormattedOutput(boolean v)

書式設定された出力フラグを設定するための簡易メソッドです。

パラメータ:

v - 書式設定された出力フラグの値

isFragment

protected boolean isFragment()

フラグメントフラグを取得するための簡易メソッドです。

戻り値:

フラグメントフラグの現在の値、または、設定されていない場合は false

setFragment

protected void setFragment(boolean v)

フラグメントフラグを設定するための簡易メソッドです。

パラメータ:

v - フラグメントフラグの値

getJavaEncoding

protected String getJavaEncoding(String encoding)
                          throws UnsupportedEncodingException

IANA 名から対応する Java エンコーディング名を取得します。 このメソッドは、派生クラスがエンコーディング名を変換するためのヘルパーメソッドです。

例外:

UnsupportedEncodingException - この実装が Java エンコーディング名を検出できなかった場合

setProperty

public void setProperty(String name,
                        Object value)
                 throws PropertyException

setProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。プロバイダは追加プロパティーを扱う必要がある場合、派生クラスでこのメソッドをオーバーライドするようにしてください。

定義:

インタフェース Marshaller 内の setProperty

パラメータ:

name - 設定するプロパティーの名前。この値は、定数フィールドの 1 つか ユーザー指定文字列を使用して指定できる

value - 設定するプロパティーの値

例外:

PropertyException - 指定したプロパティーまたは値の処理中にエラーが 発生した場合

getProperty

public Object getProperty(String name)
                   throws PropertyException

getProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。プロバイダはプロバイダ固有の追加プロパティーをサポートする必要がある場合、派生クラスでこのメソッドをオーバーライドするようにしてください。

定義:

インタフェース Marshaller 内の getProperty

パラメータ:

name - 取得するプロパティーの名前

戻り値:

要求されたプロパティーの値

例外:

PropertyException - 指定したプロパティー、またはプロパティー名値の取得中にエラーが発生 した場合

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

インタフェース Marshaller の記述:

現在のイベントハンドラ、または、それが設定されていない場合はデフォルトイベントハンドラを返します。

定義:

インタフェース Marshaller 内の getEventHandler

戻り値:

現在の ValidationEventHandler、または、それが設定されていない場合、 デフォルトイベントハンドラ

例外:

JAXBException - 現在のイベントハンドラの取得中にエラーが発生した場合

関連項目:

Marshaller.getEventHandler()

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

インタフェース Marshaller の記述:

アプリケーションが検証イベントハンドラを登録することができます。

検証イベントハンドラは、いずれかの整列化 API を呼び出している途中で検証エラーが発生した場合、JAXB プロバイダによって呼び出されます。 整列化メソッドのいずれかを呼び出す前に、クライアントアプリケーションが検証イベントハンドラを登録していない場合、検証イベントはデフォルトイベントハンドラによって処理されます。デフォルトイベントハンドラは、最初のエラーまたは致命的なエラーの発生後に整列化操作を終了させます。

このメソッドを null パラメータとともに呼び出した場合、Marshaller はデフォルトのデフォルトイベントハンドラに戻されます。

定義:

インタフェース Marshaller 内の setEventHandler

パラメータ:

handler - 検証イベントハンドラ

例外:

JAXBException - イベントハンドラの設定中にエラーが発生した場合

関連項目:

Marshaller.setEventHandler(ValidationEventHandler)

marshal

public void marshal(Object obj,
                    XMLEventWriter writer)
             throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを XMLEventWriter に整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化する jaxbElement をルートとするコンテンツツリー

writer - XML はこのライターに送信される

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が obj (または、 obj から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

marshal

public void marshal(Object obj,
                    XMLStreamWriter writer)
             throws JAXBException

インタフェース Marshaller の記述:

jaxbElement をルートとするコンテンツツリーを XMLStreamWriter に整列化します。

定義:

インタフェース Marshaller 内の marshal

パラメータ:

obj - 整列化するコンテンツツリー

writer - XML はこのライターに送信される

例外:

JAXBException - 整列化の実行中に予想外の問題が発生した場合

MarshalException - ValidationEventHandler の handleEvent メソッドから false が返されるか、または Marshaller が obj (または、 obj から到達可能なオブジェクト) を整列化できない場合。「 JAXB 要素の整列化」を参照

setSchema

public void setSchema(Schema schema)

インタフェース Marshaller の記述:

後の整列化操作の検証に使用する、JAXP 1.3 Schema オブジェクトを指定します。このメソッドに null を渡すと、検証は無効になります。

このメソッドにより、呼び出し側は整列化の実行時に、整列化される XML を検証できます。

このプロパティーは最初に null に設定されます。

定義:

インタフェース Marshaller 内の setSchema

パラメータ:

schema - 整列化操作の検証に使用するスキーマオブジェクト。検証を無効にする場合は null

getSchema

public Schema getSchema()

インタフェース Marshaller の記述:

整列化時の検証に使用される JAXP 1.3 Schema オブジェクトを取得します。Marshaller にスキーマが設定されていない場合、このメソッドは、整列化時に検証を実行しないことを示す、null を返します。

定義:

インタフェース Marshaller 内の getSchema

戻り値:

整列化時の検証を実行するために使用されるスキーマオブジェクト、 または、存在しない場合、null

setAdapter

public void setAdapter(XmlAdapter adapter)

インタフェース Marshaller の記述:

XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。

これは、setAdapter(adapter.getClass(),adapter); を呼び出す簡易メソッドです。

定義:

インタフェース Marshaller 内の setAdapter

関連項目:

Marshaller.setAdapter(Class,XmlAdapter)

setAdapter

public <A extends XmlAdapter> void setAdapter(Class<A> type,
                                              A adapter)

インタフェース Marshaller の記述:

XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。

すべての Marshaller は、内部的に Map<Class,XmlAdapter> を保持しており、フィールドまたはメソッドが XmlJavaTypeAdapter で注釈されたクラスを整列化するために使用します。

このメソッドにより、アプリケーションは XmlAdapter の設定済みのインスタンスを使用することができます。アダプタのインスタンスが与えられない場合、Marshaller はそれのデフォルトコンストラクタを呼び出してインスタンスを作成します。

定義:

インタフェース Marshaller 内の setAdapter

パラメータ:

type - アダプタの型。XmlJavaTypeAdapter.value() がこの型を参照している場合、指定したインスタンスが使用される

adapter - 使用するアダプタのインスタンス。null の場合、この型の現在のアダプタ セットの登録を取り消す

getAdapter

public <A extends XmlAdapter> A getAdapter(Class<A> type)

インタフェース Marshaller の記述:

指定した型に関連付けられているアダプタを取得します。 このメソッドは、Marshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter) メソッドの逆の操作です。

定義:

インタフェース Marshaller 内の getAdapter

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller am)

インタフェース Marshaller の記述:

XML 文書内のバイナリデータを、XML バイナリの最適化された添付として転送可能にするコンテキストを関連付けます。添付は、XML 文書コンテンツモデルから、XML 文書内に保存されたコンテンツ ID URI (cid) 参照によって参照されます。

定義:

インタフェース Marshaller 内の setAttachmentMarshaller

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

定義:

インタフェース Marshaller 内の getAttachmentMarshaller

setListener

public void setListener(Marshaller.Listener listener)

インタフェース Marshaller の記述:

この Marshaller に整列化イベントコールバック Marshaller.Listener を登録します。

各 Marshaller に Listener は 1 つだけです。Listener を設定すると、前に設定されていた Listener と置き換わります。Listener に null を設定することにより、現在の Listener の登録を解除できます。

定義:

インタフェース Marshaller 内の setListener

パラメータ:

listener - Marshaller.Listener を実装するクラスのインスタンス

getListener

public Marshaller.Listener getListener()

インタフェース Marshaller の記述:

この Marshaller に登録されている Marshaller.Listener を返します。

定義:

インタフェース Marshaller 内の getListener

戻り値:

登録されている Marshaller.Listener、または、この Marshaller に登録されている Listener がない場合、null