AbstractMarshallerImpl (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.xml.bind.helpers.AbstractMarshallerImpl

実装済みのインターフェース一覧:
Marshaller
```
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) です。
導入:
1.6、JAXB 1.0
作成者:
- Kohsuke Kawaguchi, Sun Microsystems, Inc.
関連事項:
Marshaller

ネストされたクラスの概要
- インターフェース jakarta.xml.bind.Marshaller から継承されたネストクラス / インターフェース
  Marshaller.Listener

フィールド概要
- インターフェース jakarta.xml.bind.Marshaller から継承されたフィールド
  JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

コンストラクター概要
コンストラクター
コンストラクターと説明
AbstractMarshallerImpl()

コンストラクター
コンストラクターと説明
`AbstractMarshallerImpl()`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`<A extends XmlAdapter> A`	`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> void`	`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 を設定するための便利なメソッド。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

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

- コンストラクターの詳細
  - AbstractMarshallerImpl
```
public AbstractMarshallerImpl()
```
- メソッドの詳細
  - 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 要素のマーシャリングを参照してください。
  - marshal
```
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 要素のマーシャリングを参照してください。
  - marshal
```
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 要素のマーシャリングを参照してください。
  - marshal
```
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 要素のマーシャリングを参照してください。
  - marshal
```
public final void marshal(ObjectSE obj,
                          NodeSE node)
                   throws JAXBException
```
    インターフェースからコピーされた説明: Marshaller
    jaxbElement をルートとするコンテンツツリーを DOM ツリーにマーシャリングします。
    次で指定:
    インターフェース Marshaller 内の marshal
    パラメーター:
    obj - マーシャリングされるコンテンツツリー。
    node - DOM ノードはこのノードの子として追加されます。このパラメーターは、子を受け入れるノードである必要があります ( DocumentSE、DocumentFragmentSE、ElementSE )
    例外:
    JAXBException - マーシャリング中に予期しない問題が発生した場合。
    MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。
  - getNode
```
public NodeSE getNode(ObjectSE obj)
             throws JAXBException
```
    デフォルトでは、getNode メソッドはサポートされておらず、UnsupportedOperationExceptionSE をスローします。このメソッドをサポートすることを選択した実装では、このメソッドをオーバーライドする必要があります。
    次で指定:
    インターフェース Marshaller 内の getNode
    パラメーター:
    obj - -XML コンテンツの Jakarta XML Binding Java 表現
    戻り値:
    contentTree の DOM ツリービュー
    例外:
    JAXBException - 予期しない問題が発生した場合
  - getEncoding
```
protected StringSE getEncoding()
```
    現在の出力エンコーディングを取得するための便利なメソッド。
    戻り値:
    現在のエンコーディング、または設定されていない場合は "UTF-8"。
  - setEncoding
```
protected void setEncoding(StringSE encoding)
```
    出力エンコーディングを設定するための便利なメソッド。
    パラメーター:
    encoding - Marshaller クラスのドキュメントで指定されている有効なエンコーディング
  - getSchemaLocation
```
protected StringSE getSchemaLocation()
```
    現在の schemaLocation を取得するための便利なメソッド。
    戻り値:
    現在の schemaLocation、または設定されていない場合は null
  - setSchemaLocation
```
protected void setSchemaLocation(StringSE location)
```
    schemaLocation を設定するための便利なメソッド。
    パラメーター:
    location - schemaLocation 値
  - getNoNSSchemaLocation
```
protected StringSE getNoNSSchemaLocation()
```
    現在の noNamespaceSchemaLocation を取得するための便利なメソッド。
    戻り値:
    現在の noNamespaceSchemaLocation、または設定されていない場合は null
  - setNoNSSchemaLocation
```
protected void setNoNSSchemaLocation(StringSE 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 StringSE getJavaEncoding(StringSE encoding)
                          throws UnsupportedEncodingExceptionSE
```
    IANA 名から対応する Java エンコーディング名を取得します。このメソッドは、派生クラスがエンコーディング名を変換するためのヘルパーメソッドです。
    例外:
    UnsupportedEncodingExceptionSE - この実装が Java エンコーディング名を見つけられなかった場合。
  - setProperty
```
public void setProperty(StringSE name,
                        ObjectSE value)
                 throws PropertyException
```
    setProperty メソッドの既定の実装は、Marshaller で定義された 4 つのプロパティを処理します。プロバイダーが追加のプロパティを処理する必要がある場合は、派生クラスでこのメソッドをオーバーライドする必要があります。
    次で指定:
    インターフェース Marshaller 内の setProperty
    パラメーター:
    name - 設定するプロパティの名前。この値は、定数フィールドの 1 つまたはユーザー指定の文字列を使用して指定できます。
    value - 設定するプロパティの値
    例外:
    PropertyException - 指定されたプロパティまたは値の処理中にエラーが発生した場合
  - getProperty
```
public ObjectSE getProperty(StringSE 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 の呼び出し中に検証エラーが発生した場合、検証イベントハンドラーは Jakarta XML Binding Provider によって呼び出されます。クライアントアプリケーションがマーシャルメソッドの 1 つを呼び出す前に検証イベントハンドラーを登録しない場合、検証イベントはデフォルトのイベントハンドラーによって処理され、最初のエラーまたは致命的なエラーが発生した後にマーシャル操作が終了します。
    null パラメーターを指定してこのメソッドを呼び出すと、Marshaller はデフォルトのデフォルトのイベントハンドラーに戻ります。
    次で指定:
    インターフェース Marshaller 内の setEventHandler
    パラメーター:
    handler - 検証イベントハンドラー
    例外:
    JAXBException - イベントハンドラーの設定中にエラーが発生した場合
    関連事項:
    Marshaller.setEventHandler(ValidationEventHandler)
  - marshal
```
public void marshal(ObjectSE obj,
                    XMLEventWriterSE writer)
             throws JAXBException
```
    インターフェースからコピーされた説明: Marshaller
    jaxbElement をルートとするコンテンツツリーを XMLEventWriterSE にマーシャリングします。
    次で指定:
    インターフェース Marshaller 内の marshal
    パラメーター:
    obj - マーシャリングされる jaxbElement をルートとするコンテンツツリー。
    writer - XML がこのライターに送信されます。
    例外:
    JAXBException - マーシャリング中に予期しない問題が発生した場合。
    MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。
  - marshal
```
public void marshal(ObjectSE obj,
                    XMLStreamWriterSE writer)
             throws JAXBException
```
    インターフェースからコピーされた説明: Marshaller
    jaxbElement をルートとするコンテンツツリーを XMLStreamWriterSE にマーシャリングします。
    次で指定:
    インターフェース Marshaller 内の marshal
    パラメーター:
    obj - マーシャリングされるコンテンツツリー。
    writer - XML がこのライターに送信されます。
    例外:
    JAXBException - マーシャリング中に予期しない問題が発生した場合。
    MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。
  - setSchema
```
public void setSchema(SchemaSE schema)
```
    インターフェースからコピーされた説明: Marshaller
    後続のマーシャル操作を検証するために使用する必要がある JAXP 1.3 SchemaSE オブジェクトを指定します。このメソッドに null を渡すと、検証が無効になります。
    このメソッドを使用すると、呼び出し元は、マーシャリングされた XML をマーシャリング時に検証できます。
    最初、このプロパティは null に設定されています。
    次で指定:
    インターフェース Marshaller 内の setSchema
    パラメーター:
    schema - マーシャル操作を検証するスキーマオブジェクト、または検証を無効にする null
  - getSchema
```
public SchemaSE getSchema()
```
    インターフェースからコピーされた説明: Marshaller
    マーシャル時間検証の実行に使用されている JAXP 1.3 SchemaSE オブジェクトを取得します。マーシャラーにスキーマが設定されていない場合、このメソッドは null を返し、マーシャル時間の検証が実行されないことを示します。
    次で指定:
    インターフェース Marshaller 内の getSchema
    戻り値:
    マーシャル時間の検証を実行するために使用されているスキーマオブジェクト。存在しない場合は null。
  - setAdapter
```
public void setAdapter(XmlAdapter adapter)
```
    インターフェースからコピーされた説明: Marshaller
    XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。
    これは、setAdapter(adapter.getClass(),adapter); を呼び出す便利なメソッドです。
    次で指定:
    インターフェース Marshaller 内の setAdapter
    関連事項:
    Marshaller.setAdapter(Class,XmlAdapter)
  - setAdapter
```
public <A extends XmlAdapter> void setAdapter(ClassSE<A> type,
                                              A adapter)
```
    インターフェースからコピーされた説明: Marshaller
    XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。
    すべてのマーシャラーは、MapSE <ClassSE、XmlAdapter> を内部的に維持します。これは、フィールド / メソッドに XmlJavaTypeAdapter アノテーションが付けられたマーシャリングクラスに使用されます。
    この方法により、アプリケーションは XmlAdapter の構成済みインスタンスを使用できます。アダプターのインスタンスが指定されていない場合、マーシャラーはデフォルトのコンストラクターを呼び出してアダプターを作成します。
    次で指定:
    インターフェース Marshaller 内の setAdapter
    パラメーター:
    type - アダプターの型。指定されたインスタンスは、XmlJavaTypeAdapter.value() がこの型を参照するときに使用されます。
    adapter - 使用するアダプターのインスタンス。null の場合、この型に設定されている現在のアダプターの登録が解除されます。
  - getAdapter
```
public <A extends XmlAdapter> A getAdapter(ClassSE<A> type)
```
    インターフェースからコピーされた説明: Marshaller
    指定された型に関連付けられたアダプターを取得します。これは、Marshaller.setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter) メソッドの逆の操作です。
    次で指定:
    インターフェース Marshaller 内の getAdapter
  - setAttachmentMarshaller
```
public void setAttachmentMarshaller(AttachmentMarshaller am)
```
    インターフェースからコピーされた説明: Marshaller
    XML ドキュメント内のバイナリデータを XML バイナリに最適化された添付ファイルとして送信できるようにするコンテキストを関連付けます。添付ファイルは、xml ドキュメント内に格納されている content-id URI（cid）参照によって XML ドキュメントコンテンツモデルから参照されます。
    次で指定:
    インターフェース Marshaller 内の setAttachmentMarshaller
  - getAttachmentMarshaller
```
public AttachmentMarshaller getAttachmentMarshaller()
```
    次で指定:
    インターフェース Marshaller 内の getAttachmentMarshaller
  - setListener
```
public void setListener(Marshaller.Listener listener)
```
    インターフェースからコピーされた説明: Marshaller
    マーシャルイベントコールバック Marshaller.Listener をこの Marshaller に登録します。
    マーシャラーごとにリスナーは 1 人だけです。リスナーを設定すると、以前に設定したリスナーが置き換えられます。リスナーを null に設定することにより、現在のリスナーの登録を解除できます。
    次で指定:
    インターフェース Marshaller 内の setListener
    パラメーター:
    listener - Marshaller.Listener を実装するクラスのインスタンス
  - getListener
```
public Marshaller.Listener getListener()
```
    インターフェースからコピーされた説明: Marshaller
    この Marshaller に登録されている Marshaller.Listener を返します。
    次で指定:
    インターフェース Marshaller 内の getListener
    戻り値:
    このマーシャラーにリスナーが登録されていない場合は、Marshaller.Listener または null を登録しました。

クラス AbstractMarshallerImpl

ネストされたクラスの概要

インターフェース jakarta.xml.bind.Marshaller から継承されたネストクラス / インターフェース

フィールド概要

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

コンストラクター概要

方法の概要

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

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

コンストラクターの詳細

AbstractMarshallerImpl

メソッドの詳細

marshal

marshal

marshal

marshal

marshal

getNode

getEncoding

setEncoding

getSchemaLocation

setSchemaLocation

getNoNSSchemaLocation

setNoNSSchemaLocation

isFormattedOutput

setFormattedOutput

isFragment

setFragment

getJavaEncoding

setProperty

getProperty

getEventHandler

setEventHandler

marshal

marshal

setSchema

getSchema

setAdapter

setAdapter

getAdapter

setAttachmentMarshaller

getAttachmentMarshaller

setListener

getListener