public abstract class AbstractMarshallerImpl extends ObjectSE implements Marshaller
Marshaller
実装。 このクラスは、Marshaller
インターフェースの部分的なデフォルト実装を提供します。
Jakarta XML Binding Provider が実装する必要がある唯一のメソッドは、marshal(Object, javax.xml.transform.Result)
、marshal(Object, javax.xml.stream.XMLStreamWriter)
、marshal(Object, javax.xml.stream.XMLEventWriter)
です。
Marshaller
Marshaller.Listener
JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION
コンストラクターと説明 |
---|
AbstractMarshallerImpl() |
修飾子と型 | メソッドと説明 |
---|---|
<A extends XmlAdapter> | getAdapter(ClassSE<A> type) 指定された型に関連付けられたアダプターを取得します。 |
AttachmentMarshaller | getAttachmentMarshaller() |
protected StringSE | getEncoding() 現在の出力エンコーディングを取得するための便利なメソッド。 |
ValidationEventHandler | getEventHandler() 現在のイベントハンドラー、または設定されていない場合はデフォルトのイベントハンドラーを返します。 |
protected StringSE | getJavaEncoding(StringSE encoding) IANA 名から対応する Java エンコーディング名を取得します。 |
Marshaller.Listener | getListener() この Marshaller に登録されている Marshaller.Listener を返します。 |
NodeSE | getNode(ObjectSE obj) デフォルトでは、getNode メソッドはサポートされておらず、 UnsupportedOperationException SE をスローします。 |
protected StringSE | getNoNSSchemaLocation() 現在の noNamespaceSchemaLocation を取得するための便利なメソッド。 |
ObjectSE | getProperty(StringSE name) getProperty メソッドのデフォルトの実装は、Marshaller で定義された 4 つのプロパティを処理します。 |
SchemaSE | getSchema() マーシャル時間検証の実行に使用されている JAXP 1.3 Schema SE オブジェクトを取得します。 |
protected StringSE | getSchemaLocation() 現在の schemaLocation を取得するための便利なメソッド。 |
protected boolean | isFormattedOutput() フォーマットされた出力フラグを取得するための便利なメソッド。 |
protected boolean | isFragment() フラグメントフラグを取得するための便利なメソッド。 |
void | marshal(ObjectSE obj, ContentHandlerSE handler) jaxbElement をルートとするコンテンツツリーを SAX2 イベントにマーシャリングします。 |
void | marshal(ObjectSE jaxbElement, FileSE output) jaxbElement をルートとするコンテンツツリーをファイルにマーシャリングします。 |
void | marshal(ObjectSE obj, NodeSE node) jaxbElement をルートとするコンテンツツリーを DOM ツリーにマーシャリングします。 |
void | marshal(ObjectSE obj, OutputStreamSE os) jaxbElement をルートとするコンテンツツリーを出力ストリームにマーシャリングします。 |
void | marshal(ObjectSE obj, WriterSE w) jaxbElement をルートとするコンテンツツリーをライターにマーシャリングします。 |
void | marshal(ObjectSE obj, XMLEventWriterSE writer) jaxbElement をルートとするコンテンツツリーを XMLEventWriter SE にマーシャリングします。 |
void | marshal(ObjectSE obj, XMLStreamWriterSE writer) jaxbElement をルートとするコンテンツツリーを XMLStreamWriter SE にマーシャリングします。 |
<A extends XmlAdapter> | setAdapter(ClassSE<A> type, A adapter) XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。 |
void | setAdapter(XmlAdapter adapter) XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。 |
void | setAttachmentMarshaller(AttachmentMarshaller am) XML ドキュメント内のバイナリデータを XML バイナリに最適化された添付ファイルとして送信できるようにするコンテキストを関連付けます。 |
protected void | setEncoding(StringSE encoding) 出力エンコーディングを設定するための便利なメソッド。 |
void | setEventHandler(ValidationEventHandler handler) アプリケーションが検証イベントハンドラーを登録できるようにします。 |
protected void | setFormattedOutput(boolean v) フォーマットされた出力フラグを設定するための便利なメソッド。 |
protected void | setFragment(boolean v) フラグメントフラグを設定するための便利なメソッド。 |
void | setListener(Marshaller.Listener listener) マーシャルイベントコールバック Marshaller.Listener をこの Marshaller に登録します。 |
protected void | setNoNSSchemaLocation(StringSE location) noNamespaceSchemaLocation を設定するための便利なメソッド。 |
void | setProperty(StringSE name, ObjectSE value) setProperty メソッドのデフォルトの実装は、Marshaller で定義された 4 つのプロパティを処理します。 |
void | setSchema(SchemaSE schema) 後続のマーシャル操作を検証するために使用する必要がある JAXP 1.3 Schema SE オブジェクトを指定します。 |
protected void | setSchemaLocation(StringSE location) schemaLocation を設定するための便利なメソッド。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
marshal
public final void marshal(ObjectSE obj, OutputStreamSE os) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーを出力ストリームにマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされるコンテンツツリーのルート。os
- XML がこのストリームに追加されます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public void marshal(ObjectSE jaxbElement, FileSE output) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーをファイルにマーシャリングします。Marshaller
の marshal
jaxbElement
- マーシャリングされるコンテンツツリーのルート。output
- 書き込むファイル。このファイルがすでに存在する場合は、上書きされます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public final void marshal(ObjectSE obj, WriterSE w) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーをライターにマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされるコンテンツツリーのルート。w
- XML がこのライターに送信されます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public final void marshal(ObjectSE obj, ContentHandlerSE handler) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーを SAX2 イベントにマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされるコンテンツツリーのルート。handler
- XML は SAX2 イベントとしてこのハンドラーに送信されます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public final void marshal(ObjectSE obj, NodeSE node) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーを DOM ツリーにマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされるコンテンツツリー。node
- DOM ノードはこのノードの子として追加されます。このパラメーターは、子を受け入れるノードである必要があります ( Document
SE、DocumentFragment
SE、Element
SE )JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public NodeSE getNode(ObjectSE obj) throws JAXBException
UnsupportedOperationException
SE をスローします。このメソッドをサポートすることを選択した実装は、このメソッドをオーバーライドする必要があります。Marshaller
の getNode
obj
- -XML コンテンツの Jakarta XML Binding Java 表現 JAXBException
- 予期しない問題が発生した場合 protected StringSE getEncoding()
protected void setEncoding(StringSE encoding)
encoding
- Marshaller クラスのドキュメントで指定されている有効なエンコーディング protected StringSE getSchemaLocation()
protected void setSchemaLocation(StringSE location)
location
- schemaLocation 値 protected StringSE getNoNSSchemaLocation()
protected void setNoNSSchemaLocation(StringSE location)
location
- noNamespaceSchemaLocation 値 protected boolean isFormattedOutput()
protected void setFormattedOutput(boolean v)
v
- フォーマットされた出力フラグの値。protected boolean isFragment()
protected void setFragment(boolean v)
v
- フラグメントフラグの値。protected StringSE getJavaEncoding(StringSE encoding) throws UnsupportedEncodingExceptionSE
UnsupportedEncodingExceptionSE
- この実装が Java エンコーディング名を見つけられなかった場合。public void setProperty(StringSE name, ObjectSE value) throws PropertyException
Marshaller
の setProperty
name
- 設定するプロパティの名前。この値は、定数フィールドの 1 つまたはユーザー指定の文字列を使用して指定できます。value
- 設定するプロパティの値 PropertyException
- 指定されたプロパティまたは値の処理中にエラーが発生した場合 public ObjectSE getProperty(StringSE name) throws PropertyException
Marshaller
の getProperty
name
- 取得するプロパティの名前 PropertyException
- 指定されたプロパティまたは値のプロパティ名の取得中にエラーが発生した場合 public ValidationEventHandler getEventHandler() throws JAXBException
Marshaller
Marshaller
の getEventHandler
JAXBException
- 現在のイベントハンドラーの取得中にエラーが発生した場合 Marshaller.getEventHandler()
public void setEventHandler(ValidationEventHandler handler) throws JAXBException
Marshaller
マーシャル API の呼び出し中に検証エラーが発生した場合、検証イベントハンドラーは Jakarta XML Binding Provider によって呼び出されます。クライアントアプリケーションがマーシャルメソッドの 1 つを呼び出す前に検証イベントハンドラーを登録しない場合、検証イベントはデフォルトのイベントハンドラーによって処理され、最初のエラーまたは致命的なエラーが発生した後にマーシャル操作が終了します。
null パラメーターを指定してこのメソッドを呼び出すと、Marshaller はデフォルトのデフォルトのイベントハンドラーに戻ります。
Marshaller
の setEventHandler
handler
- 検証イベントハンドラー JAXBException
- イベントハンドラーの設定中にエラーが発生した場合 Marshaller.setEventHandler(ValidationEventHandler)
public void marshal(ObjectSE obj, XMLEventWriterSE writer) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーを XMLEventWriter
SE にマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされる jaxbElement をルートとするコンテンツツリー。writer
- XML がこのライターに送信されます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public void marshal(ObjectSE obj, XMLStreamWriterSE writer) throws JAXBException
Marshaller
jaxbElement
をルートとするコンテンツツリーを XMLStreamWriter
SE にマーシャリングします。Marshaller
の marshal
obj
- マーシャリングされるコンテンツツリー。writer
- XML がこのライターに送信されます。JAXBException
- マーシャリング中に予期しない問題が発生した場合。MarshalException
- ValidationEventHandler
が handleEvent
メソッドから false を返す場合、または Marshaller
が jaxbElement
(または jaxbElement
から到達可能なオブジェクト)をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。public void setSchema(SchemaSE schema)
Marshaller
Schema
SE オブジェクトを指定します。このメソッドに null を渡すと、検証が無効になります。このメソッドを使用すると、呼び出し元は、マーシャリングされた XML をマーシャリング時に検証できます。
最初、このプロパティは null
に設定されています。
Marshaller
の setSchema
schema
- マーシャル操作を検証するスキーマオブジェクト、または検証を無効にする nullpublic SchemaSE getSchema()
Marshaller
Schema
SE オブジェクトを取得します。マーシャラーにスキーマが設定されていない場合、このメソッドは null を返し、マーシャル時間の検証が実行されないことを示します。Marshaller
の getSchema
public void setAdapter(XmlAdapter adapter)
Marshaller
XmlAdapter
の構成済みインスタンスをこのマーシャラーに関連付けます。 これは、setAdapter(adapter.getClass(),adapter);
を呼び出す便利なメソッドです。
Marshaller
の setAdapter
Marshaller.setAdapter(Class,XmlAdapter)
public <A extends XmlAdapter> void setAdapter(ClassSE<A> type, A adapter)
Marshaller
XmlAdapter
の構成済みインスタンスをこのマーシャラーに関連付けます。 すべてのマーシャラーは、Map
SE <Class
SE、XmlAdapter
> を内部的に維持します。これは、フィールド / メソッドに XmlJavaTypeAdapter
アノテーションが付けられたマーシャリングクラスに使用されます。
この方法により、アプリケーションは XmlAdapter
の構成済みインスタンスを使用できます。アダプターのインスタンスが指定されていない場合、マーシャラーはデフォルトのコンストラクターを呼び出してアダプターを作成します。
Marshaller
の setAdapter
type
- アダプターの型。指定されたインスタンスは、XmlJavaTypeAdapter.value()
がこの型を参照するときに使用されます。adapter
- 使用するアダプターのインスタンス。null の場合、この型に設定されている現在のアダプターの登録が解除されます。public <A extends XmlAdapter> A getAdapter(ClassSE<A> type)
Marshaller
Marshaller.setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)
メソッドの逆の操作です。Marshaller
の getAdapter
public void setAttachmentMarshaller(AttachmentMarshaller am)
Marshaller
XML ドキュメント内のバイナリデータを XML バイナリに最適化された添付ファイルとして送信できるようにするコンテキストを関連付けます。添付ファイルは、xml ドキュメント内に格納されている content-id URI(cid)参照によって XML ドキュメントコンテンツモデルから参照されます。
Marshaller
の setAttachmentMarshaller
public AttachmentMarshaller getAttachmentMarshaller()
Marshaller
の getAttachmentMarshaller
public void setListener(Marshaller.Listener listener)
Marshaller
マーシャルイベントコールバック Marshaller.Listener
をこの Marshaller
に登録します。
マーシャラーごとにリスナーは 1 人だけです。リスナーを設定すると、以前に設定したリスナーが置き換えられます。リスナーを null
に設定することにより、現在のリスナーの登録を解除できます。
Marshaller
の setListener
listener
- Marshaller.Listener
を実装するクラスのインスタンス public Marshaller.Listener getListener()
Marshaller
この Marshaller
に登録されている Marshaller.Listener
を返します。
Marshaller
の getListener
Marshaller.Listener
または null
を登録しました。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.