コンストラクターの詳細

• JibxMarshaller

  public JibxMarshaller()

メソッドの詳細

• setTargetClass

  public void setTargetClass(java.lang.Class<?> targetClass)

  このインスタンスのターゲットクラスを設定します。このプロパティまたは targetPackage プロパティのいずれかを設定する必要があります。

  このプロパティが設定されている場合、targetPackage は無視されます。

• setTargetPackage

  public void setTargetPackage(java.lang.String targetPackage)

  このインスタンスのターゲットパッケージを設定します。このプロパティまたは targetClass プロパティのいずれかを設定する必要があります。

  targetClass が設定されている場合、このプロパティは無視されます。

• setBindingName

  public void setBindingName(java.lang.String bindingName)

  このインスタンスのオプションのバインディング名を設定します。

• setIndent

  public void setIndent(int indent)

  ネストするインデントスペースの数を設定します。デフォルトは -1 です。つまり、インデントはありません。

• setEncoding

  public void setEncoding(java.lang.String encoding)

  マーシャリングに使用するドキュメントエンコーディングを設定します。デフォルトは UTF-8 です。

• getDefaultEncoding

  protected java.lang.String getDefaultEncoding()

  クラスからコピーされた説明: AbstractMarshaller
  バイトストリームからのマーシャリングまたはアンマーシャリングに使用するデフォルトエンコーディングを決定します。存在しない場合は null を決定します。

  デフォルトの実装は null を返します。

  オーバーライド:

  クラス AbstractMarshaller の getDefaultEncoding 

• setStandalone

  public void setStandalone(java.lang.Boolean standalone)

  マーシャリング用にドキュメントのスタンドアロンフラグを設定します。デフォルトでは、このフラグはありません。

• setDocTypeRootElementName

  public void setDocTypeRootElementName(java.lang.String docTypeRootElementName)

  マーシャリング時に書き込まれる DTD 宣言のルート要素名を設定します。デフォルトでは、これは null です（つまり、DTD 宣言は記述されていません）。

  値に設定する場合は、システム ID またはパブリック ID も設定する必要があります。

  関連事項:

  setDocTypeSystemId(String), setDocTypePublicId(String)

• setDocTypeSystemId

  public void setDocTypeSystemId(java.lang.String docTypeSystemId)

  マーシャリング時に書き込まれる DTD 宣言のシステム ID を設定します。デフォルトでは、これは null です。ルート要素も設定されている場合にのみ使用されます。

  このプロパティまたは docTypePublicId のいずれかを設定します。両方を設定することはできません。

  関連事項:

  setDocTypeRootElementName(String)

• setDocTypePublicId

  public void setDocTypePublicId(java.lang.String docTypePublicId)

  マーシャリング時に書き込まれる DTD 宣言のパブリック ID を設定します。デフォルトでは、これは null です。ルート要素も設定されている場合にのみ使用されます。

  このプロパティまたは docTypeSystemId のいずれかを設定します。両方を設定することはできません。

  関連事項:

  setDocTypeRootElementName(String)

• setDocTypeInternalSubset

  public void setDocTypeInternalSubset(java.lang.String 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(java.lang.Class<?> clazz)

  インターフェースからコピーされた説明: Marshaller
  このマーシャラーが、指定された型のインスタンスをマーシャリングできるかどうかを示します。

  次で指定:

  インターフェース Marshaller 内の supports 

  次で指定:

  インターフェース Unmarshaller 内の supports 

  パラメーター:

  clazz - このマーシャラーがマーシャリングできるかどうか尋ねられているクラス

  戻り値:

  このマーシャラーが実際に提供されたクラスのインスタンスをマーシャリングできる場合は true。それ以外の場合は false 

• marshalOutputStream

  protected void marshalOutputStream(java.lang.Object graph,
                                     java.io.OutputStream outputStream)
                              throws XmlMappingException,
                                     java.io.IOException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを OutputStream にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalOutputStream 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  outputStream - 書き込む OutputStream 

  例外:

  XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合

  java.io.IOException - I/O 例外が発生した場合

• marshalWriter

  protected void marshalWriter(java.lang.Object graph,
                               java.io.Writer writer)
                        throws XmlMappingException,
                               java.io.IOException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを Writer にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  writer - 書き込む Writer 

  例外:

  XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合

  java.io.IOException - I/O 例外が発生した場合

• marshalDomNode

  protected void marshalDomNode(java.lang.Object graph,
                                org.w3c.dom.Node node)
                         throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを DOM Node にマーシャリングする抽象テンプレートメソッド。

  実際には、ノードは Document ノード、DocumentFragment ノード、Element ノードです。つまり、子を受け入れるノードです。

  次で指定:

  クラス AbstractMarshaller の marshalDomNode 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  node - 結果ツリーを含む DOM ノード

  例外:

  XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合

  関連事項:

  Document、DocumentFragment、Element

• marshalXmlEventWriter

  protected void marshalXmlEventWriter(java.lang.Object graph,
                                       javax.xml.stream.XMLEventWriter eventWriter)

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトを StAX XMLEventWriter にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalXmlEventWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  eventWriter - 書き込む XMLEventWriter 

• marshalXmlStreamWriter

  protected void marshalXmlStreamWriter(java.lang.Object graph,
                                        javax.xml.stream.XMLStreamWriter streamWriter)
                                 throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトを StAX XMLStreamWriter にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalXmlStreamWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  streamWriter - 書き込む XMLStreamWriter 

  例外:

  XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合

• marshalSaxHandlers

  protected void marshalSaxHandlers(java.lang.Object graph,
                                    org.xml.sax.ContentHandler contentHandler,
                                    @Nullable
                                    org.xml.sax.ext.LexicalHandler lexicalHandler)
                             throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを SAX ContentHandler にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalSaxHandlers 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  contentHandler - SAX ContentHandler

  lexicalHandler - SAX2 LexicalHandler null にすることができます。

  例外:

  XmlMappingException - 指定されたオブジェクトをハンドラーにマーシャリングできない場合

• unmarshalXmlEventReader

  protected java.lang.Object unmarshalXmlEventReader(javax.xml.stream.XMLEventReader eventReader)

  クラスからコピーされた説明: AbstractMarshaller
  指定された Stax XMLEventReader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalXmlEventReader 

  パラメーター:

  eventReader - 読み込む XMLEventReader 

  戻り値:

  オブジェクトグラフ

• unmarshalXmlStreamReader

  protected java.lang.Object unmarshalXmlStreamReader(javax.xml.stream.XMLStreamReader streamReader)

  クラスからコピーされた説明: AbstractMarshaller
  指定された Stax XMLStreamReader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalXmlStreamReader 

  パラメーター:

  streamReader - 読み込む XMLStreamReader 

  戻り値:

  オブジェクトグラフ

• unmarshalInputStream

  protected java.lang.Object unmarshalInputStream(java.io.InputStream inputStream)
                                           throws XmlMappingException,
                                                  java.io.IOException

  クラスからコピーされた説明: AbstractMarshaller
  指定された InputStream から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalInputStream 

  パラメーター:

  inputStream - 読み込む InputStreamStream 

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたストリームをオブジェクトに変換できない場合

  java.io.IOException - I/O 例外が発生した場合

• unmarshalReader

  protected java.lang.Object unmarshalReader(java.io.Reader reader)
                                      throws XmlMappingException,
                                             java.io.IOException

  クラスからコピーされた説明: AbstractMarshaller
  指定された Reader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalReader 

  パラメーター:

  reader - 読み込む Reader 

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたリーダーをオブジェクトに変換できない場合

  java.io.IOException - I/O 例外が発生した場合

• unmarshalDomNode

  protected java.lang.Object unmarshalDomNode(org.w3c.dom.Node node)
                                       throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定された DOM Node から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalDomNode 

  パラメーター:

  node - 非整列化するオブジェクトを含む DOM ノード

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定された DOM ノードをオブジェクトにマップできない場合

• unmarshalSaxReader

  protected java.lang.Object unmarshalSaxReader(org.xml.sax.XMLReader xmlReader,
                                                org.xml.sax.InputSource inputSource)
                                         throws XmlMappingException,
                                                java.io.IOException

  クラスからコピーされた説明: AbstractMarshaller
  特定の SAX XMLReader および InputSource を使用して非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalSaxReader 

  パラメーター:

  xmlReader - 解析する SAX XMLReader 

  inputSource - 解析する入力ソース

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたリーダーと入力ソースをオブジェクトに変換できない場合

  java.io.IOException - 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