- 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)
のみです。- 導入されたバージョン:
- 1.6, JAXB 1.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>
AgetAdapter(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.3Schema
オブジェクトを取得します。protected String
getSchemaLocation()
現在のschemaLocationを取得するための簡易メソッドです。protected boolean
isFormattedOutput()
書式設定された出力フラグを取得するための簡易メソッドです。protected boolean
isFragment()
フラグメント・フラグを取得するための簡易メソッドです。void
marshal(Object jaxbElement, File output)
jaxbElement
をルートとするコンテンツ・ツリーをファイルに整列化します。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
に整列化します。void
marshal(Object obj, Node node)
jaxbElement
をルートとするコンテンツ・ツリーをDOMツリーに整列化します。void
marshal(Object obj, ContentHandler handler)
jaxbElement
をルートとするコンテンツ・ツリーをSAX2イベントに整列化します。<A extends XmlAdapter>
voidsetAdapter(Class<A> type, A adapter)
XmlAdapter
の構成済みのインスタンスをこのマーシャラに関連付けます。void
setAdapter(XmlAdapter adapter)
XmlAdapter
の構成済みのインスタンスをこのマーシャラに関連付けます。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.3Schema
オブジェクトを指定します。protected void
setSchemaLocation(String location)
schemaLocationを設定するための簡易メソッドです。-
インタフェース javax.xml.bind.Marshallerから継承されたメソッド
marshal
-
-
-
-
メソッドの詳細
-
marshal
public final void marshal(Object obj, OutputStream os) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーを出力ストリームに整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
obj
- 整列化するコンテンツ・ツリーのルート。os
- XMLはこのストリームに追加される。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
marshal
public void marshal(Object jaxbElement, File output) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをファイルに整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
jaxbElement
- 整列化するコンテンツ・ツリーのルート。output
- 書き込まれるファイル。 このファイルがすでに存在する場合は上書きされる。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
marshal
public final void marshal(Object obj, Writer w) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをWriterに整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
obj
- 整列化するコンテンツ・ツリーのルート。w
- XMLはこのライターに送信される。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
marshal
public final void marshal(Object obj, ContentHandler handler) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをSAX2イベントに整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
obj
- 整列化するコンテンツ・ツリーのルート。handler
- XMLはこのハンドラにSAX2イベントとして送信される。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
marshal
public final void marshal(Object obj, Node node) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをDOMツリーに整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
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
をスローします。 このメソッドをサポートすることを選択した実装は、このメソッドをオーバーライドする必要があります。- 定義:
getNode
、インタフェース:Marshaller
- パラメータ:
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つの定義済みプロパティを扱います。 プロバイダは追加プロパティを扱う必要がある場合、派生クラスでこのメソッドをオーバーライドするようにしてください。- 定義:
setProperty
、インタフェース:Marshaller
- パラメータ:
name
- 設定するプロパティの名前。 この値は、定数フィールドの1つかユーザーが指定した文字列を使用して指定できる。value
- 設定するプロパティの値- 例外:
PropertyException
- 指定したプロパティまたは値の処理中にエラーが発生した場合
-
getProperty
public Object getProperty(String name) throws PropertyException
getPropertyメソッドのデフォルト実装では、Marshallerの4つの定義済みプロパティを扱います。 プロバイダはプロバイダ固有の追加プロパティをサポートする必要がある場合、派生クラスでこのメソッドをオーバーライドするようにしてください。- 定義:
getProperty
、インタフェース:Marshaller
- パラメータ:
name
- 取得するプロパティの名前- 戻り値:
- 要求されたプロパティの値
- 例外:
PropertyException
- 指定したプロパティまたは値プロパティ名の取得中にエラーが発生した場合
-
getEventHandler
public ValidationEventHandler getEventHandler() throws JAXBException
インタフェースからコピーされた説明:Marshaller
現在のイベント・ハンドラ、または、それが設定されていない場合はデフォルト・イベント・ハンドラを返します。- 定義:
getEventHandler
、インタフェース:Marshaller
- 戻り値:
- 現在のValidationEventHandler。それが設定されていない場合はデフォルト・イベント・ハンドラ
- 例外:
JAXBException
- 現在のイベント・ハンドラの取得中にエラーが発生した場合- 関連項目:
Marshaller.getEventHandler()
-
setEventHandler
public void setEventHandler(ValidationEventHandler handler) throws JAXBException
インタフェースからコピーされた説明:Marshaller
アプリケーションが検証イベント・ハンドラを登録することができます。検証イベント・ハンドラは、いずれかの整列化APIの呼出し中に検証エラーが発生した場合、JAXBプロバイダによって呼び出されます。 整列化メソッドのいずれかを呼び出す前にクライアント・アプリケーションが検証イベント・ハンドラを登録していない場合、検証イベントはデフォルト・イベント・ハンドラによって処理されます。デフォルト・イベント・ハンドラは、最初のエラーまたは致命的なエラーの発生後に整列化操作を終了させます。
このメソッドをnullパラメータとともに呼び出した場合、Marshallerはデフォルトのデフォルト・イベント・ハンドラに戻されます。
- 定義:
setEventHandler
、インタフェース:Marshaller
- パラメータ:
handler
- 検証イベント・ハンドラ- 例外:
JAXBException
- イベント・ハンドラの設定中にエラーが発生した場合- 関連項目:
Marshaller.setEventHandler(ValidationEventHandler)
-
marshal
public void marshal(Object obj, XMLEventWriter writer) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをXMLEventWriter
に整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
obj
- 整列化するjaxbElementをルートとするコンテンツ・ツリー。writer
- XMLはこのライターに送信される。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
marshal
public void marshal(Object obj, XMLStreamWriter writer) throws JAXBException
インタフェースからコピーされた説明:Marshaller
jaxbElement
をルートとするコンテンツ・ツリーをXMLStreamWriter
に整列化します。- 定義:
marshal
、インタフェース:Marshaller
- パラメータ:
obj
- 整列化するコンテンツ・ツリー。writer
- XMLはこのライターに送信される。- 例外:
JAXBException
- 整列化の実行中に予想外の問題が発生した場合。MarshalException
-ValidationEventHandler
のhandleEvent
メソッドからfalseが返されるか、Marshaller
がjaxbElement
(またはjaxbElement
から到達可能なオブジェクト)を整列化できない場合。 JAXB要素の整列化を参照。
-
setSchema
public void setSchema(Schema schema)
インタフェースからコピーされた説明:Marshaller
後の整列化操作の検証に使用する、JAXP 1.3Schema
オブジェクトを指定します。 このメソッドにnullを渡すと、検証は無効になります。このメソッドにより、呼出し側は整列化の実行時に、整列化されるXMLを検証できます。
このプロパティは最初に
null
に設定されます。- 定義:
setSchema
、インタフェース:Marshaller
- パラメータ:
schema
- 整列化操作の検証に使用するスキーマ・オブジェクト。検証を無効にする場合はnull
-
getSchema
public Schema getSchema()
インタフェースからコピーされた説明:Marshaller
整列化時の検証に使用されるJAXP 1.3Schema
オブジェクトを取得します。 Marshallerにスキーマが設定されていない場合、このメソッドは、整列化時に検証を実行しないことを示す、nullを返します。- 定義:
getSchema
、インタフェース:Marshaller
- 戻り値:
- 整列化時の検証を実行するために使用されるスキーマ・オブジェクト。存在しない場合はnull。
-
setAdapter
public void setAdapter(XmlAdapter adapter)
インタフェースからコピーされた説明:Marshaller
XmlAdapter
の構成済みのインスタンスをこのマーシャラに関連付けます。これは
setAdapter(adapter.getClass(),adapter);
を呼び出す簡易メソッドです。- 定義:
setAdapter
、インタフェース:Marshaller
- 関連項目:
Marshaller.setAdapter(Class,XmlAdapter)
-
setAdapter
public <A extends XmlAdapter> void setAdapter(Class<A> type, A adapter)
インタフェースからコピーされた説明:Marshaller
XmlAdapter
の構成済みのインスタンスをこのマーシャラに関連付けます。すべてのMarshallerは、内部的に
Map
<Class
,XmlAdapter
>を保持しており、フィールドまたはメソッドがXmlJavaTypeAdapter
で注釈されたクラスを整列化するために使用します。このメソッドにより、アプリケーションは
XmlAdapter
の構成済みのインスタンスを使用できます。 アダプタのインスタンスが与えられない場合、Marshallerはそれのデフォルト・コンストラクタを呼び出してインスタンスを作成します。- 定義:
setAdapter
、インタフェース:Marshaller
- パラメータ:
type
- アダプタの型。XmlJavaTypeAdapter.value()
がこの型を参照する場合は、指定したインスタンスが使用される。adapter
- 使用するアダプタのインスタンス。 nullの場合、この型に対して現在設定されているアダプタの登録が解除される。
-
getAdapter
public <A extends XmlAdapter> A getAdapter(Class<A> type)
インタフェースからコピーされた説明:Marshaller
指定した型に関連付けられているアダプタを取得します。 これは、Marshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)
メソッドの逆の操作です。- 定義:
getAdapter
、インタフェース:Marshaller
-
setAttachmentMarshaller
public void setAttachmentMarshaller(AttachmentMarshaller am)
インタフェースからコピーされた説明:Marshaller
XML文書内のバイナリ・データを、XMLバイナリの最適化された添付として転送可能にするコンテキストを関連付けます。 添付は、XML文書コンテンツ・モデルから、XML文書内に保存されたコンテンツID URI (cid)参照によって参照されます。
- 定義:
setAttachmentMarshaller
、インタフェース:Marshaller
-
getAttachmentMarshaller
public AttachmentMarshaller getAttachmentMarshaller()
- 定義:
getAttachmentMarshaller
、インタフェース:Marshaller
-
setListener
public void setListener(Marshaller.Listener listener)
インタフェースからコピーされた説明:Marshaller
この
Marshaller
に整列化イベント・コールバックMarshaller.Listener
を登録します。各MarshallerにListenerは1つだけです。 Listenerを設定すると、前に設定されていたListenerと置き換わります。 Listenerに
null
を設定することにより、現在のListenerの登録を解除できます。- 定義:
setListener
、インタフェース:Marshaller
- パラメータ:
listener
-Marshaller.Listener
を実装するクラスのインスタンス
-
getListener
public Marshaller.Listener getListener()
インタフェースからコピーされた説明:Marshaller
この
Marshaller
に登録されたMarshaller.Listener
を返します。- 定義:
getListener
、インタフェース:Marshaller
- 戻り値:
- 登録されている
Marshaller.Listener
、またはこのMarshallerに登録されているListenerがない場合null
。
-
-