JibxMarshaller (Spring Framework 5.2.9.RELEASE API)

java.lang.ObjectSE
- org.springframework.oxm.support.AbstractMarshaller
- - org.springframework.oxm.jibx.JibxMarshaller

実装されているすべてのインターフェース:
InitializingBean, Marshaller, Unmarshaller
使用すべきではありません。
Spring Framework 5.1.5 現在、JiBX プロジェクトでの活動がないため
```
@DeprecatedSE
public class JibxMarshaller
extends AbstractMarshaller
implements InitializingBean
```
JiBX 用の Marshaller および Unmarshaller インターフェースの実装。
典型的な使用箇所は、この Bean で targetClass およびオプションで bindingName プロパティを設定することです。
導入:
3.0
作成者:
Arjen Poutsma
関連事項:
IMarshallingContext, IUnmarshallingContext

フィールドのサマリー
- クラス org.springframework.oxm.support.AbstractMarshaller から継承されたフィールド
  logger

コンストラクターの概要
コンストラクター
コンストラクターと説明
JibxMarshaller()
使用すべきではありません。

コンストラクター
コンストラクターと説明
`JibxMarshaller()` 使用すべきではありません。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 使用すべきではありません。すべての Bean プロパティを設定し、`BeanFactoryAware`、`ApplicationContextAware` などを満たした後、包含 `BeanFactory` によって呼び出されます。
`XmlMappingException`	`convertJibxException(org.jibx.runtime.JiBXException ex, boolean marshalling)` 使用すべきではありません。指定された `JiBXException` を `org.springframework.oxm` 階層からの適切な例外に変換します。
`protected org.jibx.runtime.IMarshallingContext`	`createMarshallingContext()` 使用すべきではありません。正しいインデントで構成された新しい `IMarshallingContext` を作成します。
`protected org.jibx.runtime.IUnmarshallingContext`	`createUnmarshallingContext()` 使用すべきではありません。新しい `IUnmarshallingContext` を作成します。
`protected StringSE`	`getDefaultEncoding()` 使用すべきではありません。バイトストリームからのマーシャリングまたはアンマーシャリングに使用するデフォルトエンコーディングを決定します。存在しない場合は `null` を決定します。
`protected void`	`marshalDomNode(ObjectSE graph, NodeSE node)` 使用すべきではありません。指定されたオブジェクトグラフを DOM `Node` にマーシャリングする抽象テンプレートメソッド。
`protected void`	`marshalOutputStream(ObjectSE graph, OutputStreamSE outputStream)` 使用すべきではありません。指定されたオブジェクトグラフを `OutputStream` にマーシャリングする抽象テンプレートメソッド。
`protected void`	`marshalSaxHandlers(ObjectSE graph, ContentHandlerSE contentHandler, LexicalHandlerSE lexicalHandler)` 使用すべきではありません。指定されたオブジェクトグラフを SAX `ContentHandler` にマーシャリングする抽象テンプレートメソッド。
`protected void`	`marshalWriter(ObjectSE graph, WriterSE writer)` 使用すべきではありません。指定されたオブジェクトグラフを `Writer` にマーシャリングする抽象テンプレートメソッド。
`protected void`	`marshalXmlEventWriter(ObjectSE graph, XMLEventWriterSE eventWriter)` 使用すべきではありません。指定されたオブジェクトを StAX `XMLEventWriter` にマーシャリングする抽象テンプレートメソッド。
`protected void`	`marshalXmlStreamWriter(ObjectSE graph, XMLStreamWriterSE streamWriter)` 使用すべきではありません。指定されたオブジェクトを StAX `XMLStreamWriter` にマーシャリングする抽象テンプレートメソッド。
`void`	`setBindingName(StringSE bindingName)` 使用すべきではありません。このインスタンスのオプションのバインディング名を設定します。
`void`	`setDocTypeInternalSubset(StringSE docTypeInternalSubset)` 使用すべきではありません。マーシャリング時に書き込まれる DTD 宣言の内部サブセット ID を設定します。
`void`	`setDocTypePublicId(StringSE docTypePublicId)` 使用すべきではありません。マーシャリング時に書き込まれる DTD 宣言のパブリック ID を設定します。
`void`	`setDocTypeRootElementName(StringSE docTypeRootElementName)` 使用すべきではありません。マーシャリング時に書き込まれる DTD 宣言のルート要素名を設定します。
`void`	`setDocTypeSystemId(StringSE docTypeSystemId)` 使用すべきではありません。マーシャリング時に書き込まれる DTD 宣言のシステム ID を設定します。
`void`	`setEncoding(StringSE encoding)` 使用すべきではありません。マーシャリングに使用するドキュメントエンコーディングを設定します。
`void`	`setIndent(int indent)` 使用すべきではありません。ネストするインデントスペースの数を設定します。
`void`	`setStandalone(BooleanSE standalone)` 使用すべきではありません。マーシャリング用にドキュメントのスタンドアロンフラグを設定します。
`void`	`setTargetClass(ClassSE<?> targetClass)` 使用すべきではありません。このインスタンスのターゲットクラスを設定します。
`void`	`setTargetPackage(StringSE targetPackage)` 使用すべきではありません。このインスタンスのターゲットパッケージを設定します。
`boolean`	`supports(ClassSE<?> clazz)` 使用すべきではありません。このマーシャラーが、指定された型のインスタンスをマーシャリングできるかどうかを示します。
`protected ObjectSE`	`unmarshalDomNode(NodeSE node)` 使用すべきではありません。指定された DOM `Node` から非整列化するための抽象テンプレートメソッド。
`protected ObjectSE`	`unmarshalInputStream(InputStreamSE inputStream)` 使用すべきではありません。指定された `InputStream` から非整列化するための抽象テンプレートメソッド。
`protected ObjectSE`	`unmarshalReader(ReaderSE reader)` 使用すべきではありません。指定された `Reader` から非整列化するための抽象テンプレートメソッド。
`protected ObjectSE`	`unmarshalSaxReader(XMLReaderSE xmlReader, InputSourceSE inputSource)` 使用すべきではありません。特定の SAX `XMLReader` および `InputSource` を使用して非整列化するための抽象テンプレートメソッド。
`protected ObjectSE`	`unmarshalXmlEventReader(XMLEventReaderSE eventReader)` 使用すべきではありません。指定された Stax `XMLEventReader` から非整列化するための抽象テンプレートメソッド。
`protected ObjectSE`	`unmarshalXmlStreamReader(XMLStreamReaderSE streamReader)` 使用すべきではありません。指定された Stax `XMLStreamReader` から非整列化するための抽象テンプレートメソッド。

クラス org.springframework.oxm.support.AbstractMarshaller から継承されたメソッド
buildDocument, createDocumentBuilder, createDocumentBuilderFactory, createXmlReader, isProcessExternalEntities, isSupportDtd, marshal, marshalDomResult, marshalSaxResult, marshalStaxResult, marshalStreamResult, setProcessExternalEntities, setSupportDtd, unmarshal, unmarshalDomSource, unmarshalSaxSource, unmarshalStaxSource, unmarshalStreamSource

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

- コンストラクターの詳細
  - JibxMarshaller
```
public JibxMarshaller()
```
    使用すべきではありません。
- メソッドの詳細
  - setTargetClass
```
public void setTargetClass(ClassSE<?> targetClass)
```
    使用すべきではありません。
    このインスタンスのターゲットクラスを設定します。このプロパティまたは targetPackage プロパティのいずれかを設定する必要があります。
    このプロパティが設定されている場合、targetPackage は無視されます。
  - setTargetPackage
```
public void setTargetPackage(StringSE targetPackage)
```
    使用すべきではありません。
    このインスタンスのターゲットパッケージを設定します。このプロパティまたは targetClass プロパティのいずれかを設定する必要があります。
    targetClass が設定されている場合、このプロパティは無視されます。
  - setBindingName
```
public void setBindingName(StringSE bindingName)
```
    使用すべきではありません。
    このインスタンスのオプションのバインディング名を設定します。
  - setIndent
```
public void setIndent(int indent)
```
    使用すべきではありません。
    ネストするインデントスペースの数を設定します。デフォルトは -1 です。つまり、インデントはありません。
  - setEncoding
```
public void setEncoding(StringSE encoding)
```
    使用すべきではありません。
    マーシャリングに使用するドキュメントエンコーディングを設定します。デフォルトは UTF-8 です。
  - getDefaultEncoding
```
protected StringSE getDefaultEncoding()
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    バイトストリームからのマーシャリングまたはアンマーシャリングに使用するデフォルトエンコーディングを決定します。存在しない場合は null を決定します。
    デフォルトの実装は null を返します。
    オーバーライド:
    クラス AbstractMarshaller の getDefaultEncoding
  - setStandalone
```
public void setStandalone(BooleanSE standalone)
```
    使用すべきではありません。
    マーシャリング用にドキュメントのスタンドアロンフラグを設定します。デフォルトでは、このフラグはありません。
  - setDocTypeRootElementName
```
public void setDocTypeRootElementName(StringSE docTypeRootElementName)
```
    使用すべきではありません。
    マーシャリング時に書き込まれる DTD 宣言のルート要素名を設定します。デフォルトでは、これは null です（つまり、DTD 宣言は記述されていません）。
    値に設定する場合は、システム ID またはパブリック ID も設定する必要があります。
    関連事項:
    setDocTypeSystemId(String), setDocTypePublicId(String)
  - setDocTypeSystemId
```
public void setDocTypeSystemId(StringSE docTypeSystemId)
```
    使用すべきではありません。
    マーシャリング時に書き込まれる DTD 宣言のシステム ID を設定します。デフォルトでは、これは null です。ルート要素も設定されている場合にのみ使用されます。
    このプロパティまたは docTypePublicId のいずれかを設定します。両方を設定することはできません。
    関連事項:
    setDocTypeRootElementName(String)
  - setDocTypePublicId
```
public void setDocTypePublicId(StringSE docTypePublicId)
```
    使用すべきではありません。
    マーシャリング時に書き込まれる DTD 宣言のパブリック ID を設定します。デフォルトでは、これは null です。ルート要素も設定されている場合にのみ使用されます。
    このプロパティまたは docTypeSystemId のいずれかを設定します。両方を設定することはできません。
    関連事項:
    setDocTypeRootElementName(String)
  - setDocTypeInternalSubset
```
public void setDocTypeInternalSubset(StringSE docTypeInternalSubset)
```
    使用すべきではありません。
    マーシャリング時に書き込まれる DTD 宣言の内部サブセット ID を設定します。デフォルトでは、これは null です。ルート要素も設定されている場合にのみ使用されます。
    関連事項:
    setDocTypeRootElementName(String)
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws org.jibx.runtime.JiBXException
```
    使用すべきではありません。
    インターフェースからコピーされた説明: InitializingBean
    すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    org.jibx.runtime.JiBXException
  - supports
```
public boolean supports(ClassSE<?> clazz)
```
    使用すべきではありません。
    インターフェースからコピーされた説明: Marshaller
    このマーシャラーが、指定された型のインスタンスをマーシャリングできるかどうかを示します。
    次で指定:
    インターフェース Marshaller の supports
    次で指定:
    インターフェース Unmarshaller の supports
    パラメーター:
    clazz - このマーシャラーがマーシャリングできるかどうか尋ねられているクラス
    戻り値:
    このマーシャラーが実際に提供されたクラスのインスタンスをマーシャリングできる場合は true。それ以外の場合は false
  - marshalOutputStream
```
protected void marshalOutputStream(ObjectSE graph,
                                   OutputStreamSE outputStream)
                            throws XmlMappingException,
                                   IOExceptionSE
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトグラフを OutputStream にマーシャリングする抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の marshalOutputStream
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    outputStream - 書き込む OutputStream
    例外:
    XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合
    IOExceptionSE - I/O 例外が発生した場合
  - marshalWriter
```
protected void marshalWriter(ObjectSE graph,
                             WriterSE writer)
                      throws XmlMappingException,
                             IOExceptionSE
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトグラフを Writer にマーシャリングする抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の marshalWriter
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    writer - 書き込む Writer
    例外:
    XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合
    IOExceptionSE - I/O 例外が発生した場合
  - marshalDomNode
```
protected void marshalDomNode(ObjectSE graph,
                              NodeSE node)
                       throws XmlMappingException
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトグラフを DOM Node にマーシャリングする抽象テンプレートメソッド。
    実際には、ノードは Document ノード、DocumentFragment ノード、Element ノードです。つまり、子を受け入れるノードです。
    次で指定:
    クラス AbstractMarshaller の marshalDomNode
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    node - 結果ツリーを含む DOM ノード
    例外:
    XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合
    関連事項:
    DocumentSE, DocumentFragmentSE, ElementSE
  - marshalXmlEventWriter
```
protected void marshalXmlEventWriter(ObjectSE graph,
                                     XMLEventWriterSE eventWriter)
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトを StAX XMLEventWriter にマーシャリングする抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の marshalXmlEventWriter
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    eventWriter - 書き込む XMLEventWriter
  - marshalXmlStreamWriter
```
protected void marshalXmlStreamWriter(ObjectSE graph,
                                      XMLStreamWriterSE streamWriter)
                               throws XmlMappingException
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトを StAX XMLStreamWriter にマーシャリングする抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の marshalXmlStreamWriter
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    streamWriter - 書き込む XMLStreamWriter
    例外:
    XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合
  - marshalSaxHandlers
```
protected void marshalSaxHandlers(ObjectSE graph,
                                  ContentHandlerSE contentHandler,
                                  @Nullable
                                  LexicalHandlerSE lexicalHandler)
                           throws XmlMappingException
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定されたオブジェクトグラフを SAX ContentHandler にマーシャリングする抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の marshalSaxHandlers
    パラメーター:
    graph - マーシャリングするオブジェクトグラフのルート
    contentHandler - SAX ContentHandler
    lexicalHandler - SAX2 LexicalHandler null にすることができます。
    例外:
    XmlMappingException - 指定されたオブジェクトをハンドラーにマーシャリングできない場合
  - unmarshalXmlEventReader
```
protected ObjectSE unmarshalXmlEventReader(XMLEventReaderSE eventReader)
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定された Stax XMLEventReader から非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalXmlEventReader
    パラメーター:
    eventReader - 読み込む XMLEventReader
    戻り値:
    オブジェクトグラフ
  - unmarshalXmlStreamReader
```
protected ObjectSE unmarshalXmlStreamReader(XMLStreamReaderSE streamReader)
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定された Stax XMLStreamReader から非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalXmlStreamReader
    パラメーター:
    streamReader - 読み込む XMLStreamReader
    戻り値:
    オブジェクトグラフ
  - unmarshalInputStream
```
protected ObjectSE unmarshalInputStream(InputStreamSE inputStream)
                               throws XmlMappingException,
                                      IOExceptionSE
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定された InputStream から非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalInputStream
    パラメーター:
    inputStream - 読み込む InputStreamStream
    戻り値:
    オブジェクトグラフ
    例外:
    XmlMappingException - 指定されたストリームをオブジェクトに変換できない場合
    IOExceptionSE - I/O 例外が発生した場合
  - unmarshalReader
```
protected ObjectSE unmarshalReader(ReaderSE reader)
                          throws XmlMappingException,
                                 IOExceptionSE
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定された Reader から非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalReader
    パラメーター:
    reader - 読み込む Reader
    戻り値:
    オブジェクトグラフ
    例外:
    XmlMappingException - 指定されたリーダーをオブジェクトに変換できない場合
    IOExceptionSE - I/O 例外が発生した場合
  - unmarshalDomNode
```
protected ObjectSE unmarshalDomNode(NodeSE node)
                           throws XmlMappingException
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    指定された DOM Node から非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalDomNode
    パラメーター:
    node - 非整列化するオブジェクトを含む DOM ノード
    戻り値:
    オブジェクトグラフ
    例外:
    XmlMappingException - 指定された DOM ノードをオブジェクトにマップできない場合
  - unmarshalSaxReader
```
protected ObjectSE unmarshalSaxReader(XMLReaderSE xmlReader,
                                    InputSourceSE inputSource)
                             throws XmlMappingException,
                                    IOExceptionSE
```
    使用すべきではありません。
    クラスからコピーされた説明: AbstractMarshaller
    特定の SAX XMLReader および InputSource を使用して非整列化するための抽象テンプレートメソッド。
    次で指定:
    クラス AbstractMarshaller の unmarshalSaxReader
    パラメーター:
    xmlReader - 解析する SAX XMLReader
    inputSource - 解析する入力ソース
    戻り値:
    オブジェクトグラフ
    例外:
    XmlMappingException - 指定されたリーダーと入力ソースをオブジェクトに変換できない場合
    IOExceptionSE - I/O 例外が発生した場合
  - createMarshallingContext
```
protected org.jibx.runtime.IMarshallingContext createMarshallingContext()
                                                                 throws org.jibx.runtime.JiBXException
```
    使用すべきではありません。
    正しいインデントで構成された新しい IMarshallingContext を作成します。
    戻り値:
    作成されたマーシャリングコンテキスト
    例外:
    org.jibx.runtime.JiBXException - エラーの場合
  - createUnmarshallingContext
```
protected org.jibx.runtime.IUnmarshallingContext createUnmarshallingContext()
                                                                     throws org.jibx.runtime.JiBXException
```
    使用すべきではありません。
    新しい IUnmarshallingContext を作成します。
    戻り値:
    作成された非整列化コンテキスト
    例外:
    org.jibx.runtime.JiBXException - エラーの場合
  - convertJibxException
```
public XmlMappingException convertJibxException(org.jibx.runtime.JiBXException ex,
                                                boolean marshalling)
```
    使用すべきではありません。
    指定された JiBXException を org.springframework.oxm 階層からの適切な例外に変換します。
    JiBX 自体は例外階層でこの区別を行わないため、ブール化フラグを使用して、この例外がマーシャリング中に発生するかアンマーシャリング中に発生するかを示します。
    パラメーター:
    ex - 発生した JiBXException
    marshalling - マーシャリング中に例外が発生するか（true）、アンマーシャリングするかを示します (false)
    戻り値:
    対応する XmlMappingException

クラス JibxMarshaller

フィールドのサマリー

クラス org.springframework.oxm.support.AbstractMarshaller から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.oxm.support.AbstractMarshaller から継承されたメソッド

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

コンストラクターの詳細

JibxMarshaller

メソッドの詳細

setTargetClass

setTargetPackage

setBindingName

setIndent

setEncoding

getDefaultEncoding

setStandalone

setDocTypeRootElementName

setDocTypeSystemId

setDocTypePublicId

setDocTypeInternalSubset

afterPropertiesSet

supports

marshalOutputStream

marshalWriter

marshalDomNode

marshalXmlEventWriter

marshalXmlStreamWriter

marshalSaxHandlers

unmarshalXmlEventReader

unmarshalXmlStreamReader

unmarshalInputStream

unmarshalReader

unmarshalDomNode

unmarshalSaxReader

createMarshallingContext

createUnmarshallingContext

convertJibxException