フィールドの詳細

• JAXB_ENCODING

  static final StringSE JAXB_ENCODING

  マーシャリングされた XML データの出力エンコーディングを指定するために使用されるプロパティの名前。

  関連事項:

  定数フィールド値

• JAXB_FORMATTED_OUTPUT

  static final StringSE JAXB_FORMATTED_OUTPUT

  マーシャリングされた XML データが改行とインデントでフォーマットされているかどうかを指定するために使用されるプロパティの名前。

  関連事項:

  定数フィールド値

• JAXB_SCHEMA_LOCATION

  static final StringSE JAXB_SCHEMA_LOCATION

  マーシャリングされた XML 出力に配置する xsi:schemaLocation 属性値を指定するために使用されるプロパティの名前。

  関連事項:

  定数フィールド値

• JAXB_NO_NAMESPACE_SCHEMA_LOCATION

  static final StringSE JAXB_NO_NAMESPACE_SCHEMA_LOCATION

  マーシャリングされた XML 出力に配置する xsi:noNamespaceSchemaLocation 属性値を指定するために使用されるプロパティの名前。

  関連事項:

  定数フィールド値

• JAXB_FRAGMENT

  static final StringSE JAXB_FRAGMENT

  マーシャラーがドキュメントレベルのイベント (つまり、startDocument または endDocument の呼び出し) を生成するかどうかを指定するために使用されるプロパティの名前。

  関連事項:

  定数フィールド値

メソッドの詳細

• marshal

  void marshal​(ObjectSE jaxbElement,
               ResultSE result)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを指定された javax.xml.transform.Result にマーシャリングします。

  すべての Jakarta XML Binding Providers は、少なくとも DOMResultSE、SAXResultSE、StreamResultSE をサポートする必要があります。Result の他の派生クラスもサポートできます。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリーのルート。

  result - XML がこの結果に送信されます

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

• marshal

  void marshal​(ObjectSE jaxbElement,
               OutputStreamSE os)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを出力ストリームにマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリーのルート。

  os - XML がこのストリームに追加されます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

• marshal

  void marshal​(ObjectSE jaxbElement,
               FileSE output)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーをファイルにマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリーのルート。

  output - 書き込むファイル。このファイルがすでに存在する場合は、上書きされます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

  導入:

  1.6、JAXB 2.1

• marshal

  void marshal​(ObjectSE jaxbElement,
               WriterSE writer)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーをライターにマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリーのルート。

  writer - XML がこのライターに送信されます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

• marshal

  void marshal​(ObjectSE jaxbElement,
               ContentHandlerSE handler)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを SAX2 イベントにマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリーのルート。

  handler - XML は SAX2 イベントとしてこのハンドラーに送信されます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

• marshal

  void marshal​(ObjectSE jaxbElement,
               NodeSE node)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを DOM ツリーにマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリー。

  node - DOM ノードはこのノードの子として追加されます。このパラメーターは、子を受け入れるノードである必要があります ( DocumentSE、DocumentFragmentSE、ElementSE )

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

• marshal

  void marshal​(ObjectSE jaxbElement,
               XMLStreamWriterSE writer)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを XMLStreamWriterSE にマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされるコンテンツツリー。

  writer - XML がこのライターに送信されます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

  導入:

  1.6、JAXB 2.0

• marshal

  void marshal​(ObjectSE jaxbElement,
               XMLEventWriterSE writer)
        throws JAXBException

  jaxbElement をルートとするコンテンツツリーを XMLEventWriterSE にマーシャリングします。

  パラメーター:

  jaxbElement - マーシャリングされる jaxbElement をルートとするコンテンツツリー。

  writer - XML がこのライターに送信されます。

  例外:

  JAXBException - マーシャリング中に予期しない問題が発生した場合。

  MarshalException - ValidationEventHandler が handleEvent メソッドから false を返す場合、または Marshaller が jaxbElement （または jaxbElement から到達可能なオブジェクト）をマーシャリングできない場合。 Jakarta XML Binding 要素のマーシャリングを参照してください。

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

  導入:

  1.6、JAXB 2.0

• getNode

  NodeSE getNode​(ObjectSE contentTree)
        throws JAXBException

  コンテンツツリーの DOM ツリービューを取得します（オプション）。返された DOM ツリーが更新されると、これらの変更はコンテンツツリーにも表示されます。marshal(Object, org.w3c.dom.Node) を使用して、コンテンツツリーのディープコピーを DOM 表現に強制します。

  パラメーター:

  contentTree - -XML コンテンツの Jakarta XML Binding Java 表現

  戻り値:

  contentTree の DOM ツリービュー

  例外:

  UnsupportedOperationExceptionSE - Jakarta XML Binding プロバイダーの実装がコンテンツツリーの DOM ビューをサポートしていない場合

  IllegalArgumentExceptionSE - メソッドパラメーターのいずれかが null の場合

  JAXBException - 予期しない問題が発生した場合

• setProperty

  void setProperty​(StringSE name,
                   ObjectSE value)
            throws PropertyException

  Marshaller の基礎となる実装で特定のプロパティを設定します。このメソッドは、上記の標準 Jakarta XML Binding 定義プロパティの 1 つ、またはプロバイダー固有のプロパティを設定するためにのみ使用できます。未定義のプロパティを設定しようとすると、PropertyException がスローされます。サポートされているプロパティを参照してください。

  パラメーター:

  name - 設定するプロパティの名前。この値は、定数フィールドの 1 つまたはユーザー指定の文字列を使用して指定できます。

  value - 設定するプロパティの値

  例外:

  PropertyException - 指定されたプロパティまたは値の処理中にエラーが発生した場合

  IllegalArgumentExceptionSE - name パラメーターが null の場合

• getProperty

  ObjectSE getProperty​(StringSE name)
              throws PropertyException

  Marshaller の基礎となる実装で特定のプロパティを取得します。このメソッドは、上記の標準 Jakarta XML Binding 定義プロパティの 1 つ、またはプロバイダー固有のプロパティを取得するためにのみ使用できます。未定義のプロパティを取得しようとすると、PropertyException がスローされます。サポートされているプロパティを参照してください。

  パラメーター:

  name - 取得するプロパティの名前

  戻り値:

  リクエストされたプロパティの値

  例外:

  PropertyException - 指定されたプロパティまたは値のプロパティ名の取得中にエラーが発生した場合

  IllegalArgumentExceptionSE - name パラメーターが null の場合

• setEventHandler

  void setEventHandler​(ValidationEventHandler handler)
                throws JAXBException

  アプリケーションが検証イベントハンドラーを登録できるようにします。

  マーシャル API の呼び出し中に検証エラーが発生した場合、検証イベントハンドラーは Jakarta XML Binding Provider によって呼び出されます。クライアントアプリケーションがマーシャルメソッドの 1 つを呼び出す前に検証イベントハンドラーを登録しない場合、検証イベントはデフォルトのイベントハンドラーによって処理され、最初のエラーまたは致命的なエラーが発生した後にマーシャル操作が終了します。

  null パラメーターを指定してこのメソッドを呼び出すと、Marshaller はデフォルトのデフォルトのイベントハンドラーに戻ります。

  パラメーター:

  handler - 検証イベントハンドラー

  例外:

  JAXBException - イベントハンドラーの設定中にエラーが発生した場合

• getEventHandler

  ValidationEventHandler getEventHandler()
                                  throws JAXBException

  現在のイベントハンドラー、または設定されていない場合はデフォルトのイベントハンドラーを返します。

  戻り値:

  現在の ValidationEventHandler、または設定されていない場合はデフォルトのイベントハンドラー

  例外:

  JAXBException - 現在のイベントハンドラーの取得中にエラーが発生した場合

• setAdapter

  <A extends XmlAdapter<?,​?>> void setAdapter​(A adapter)

  XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。

  これは、setAdapter(adapter.getClass(),adapter); を呼び出す便利なメソッドです。

  型パラメーター:

  A - アダプターの型

  パラメーター:

  adapter - 使用するアダプターのインスタンス。null の場合、この型に設定されている現在のアダプターの登録が解除されます。

  例外:

  IllegalArgumentExceptionSE - アダプターパラメーターが null の場合。

  UnsupportedOperationExceptionSE - JAXB 1.0 実装に対して再度呼び出された場合。

  導入:

  1.6、JAXB 2.0

  関連事項:

  setAdapter(Class,XmlAdapter)

• setAdapter

  <A extends XmlAdapter<?,​?>> void setAdapter​(ClassSE<A> type,
                                                    A adapter)

  XmlAdapter の構成済みインスタンスをこのマーシャラーに関連付けます。

  すべてのマーシャラーは、MapSE <ClassSE、XmlAdapter> を内部的に維持します。これは、フィールド / メソッドに XmlJavaTypeAdapter アノテーションが付けられたマーシャリングクラスに使用されます。

  この方法により、アプリケーションは XmlAdapter の構成済みインスタンスを使用できます。アダプターのインスタンスが指定されていない場合、マーシャラーはデフォルトのコンストラクターを呼び出してアダプターを作成します。

  型パラメーター:

  A - アダプターの型

  パラメーター:

  type - アダプターの型。指定されたインスタンスは、XmlJavaTypeAdapter.value() がこの型を参照するときに使用されます。

  adapter - 使用するアダプターのインスタンス。null の場合、この型に設定されている現在のアダプターの登録が解除されます。

  例外:

  IllegalArgumentExceptionSE - type パラメーターが null の場合。

  UnsupportedOperationExceptionSE - JAXB 1.0 実装に対して再度呼び出された場合。

  導入:

  1.6、JAXB 2.0

• getAdapter

  <A extends XmlAdapter<?,​?>> A getAdapter​(ClassSE<A> type)

  指定された型に関連付けられたアダプターを取得します。これは、setAdapter(A) メソッドの逆の操作です。

  型パラメーター:

  A - アダプターの型

  パラメーター:

  type - アダプターの型。指定されたインスタンスは、XmlJavaTypeAdapter.value() がこの型を参照するときに使用されます。

  戻り値:

  指定された型に関連付けられたアダプター。

  例外:

  IllegalArgumentExceptionSE - type パラメーターが null の場合。

  UnsupportedOperationExceptionSE - JAXB 1.0 実装に対して再度呼び出された場合。

  導入:

  1.6、JAXB 2.0

• setAttachmentMarshaller

  void setAttachmentMarshaller​(AttachmentMarshaller am)

  XML ドキュメント内のバイナリデータを XML バイナリに最適化された添付ファイルとして送信できるようにするコンテキストを関連付けます。添付ファイルは、xml ドキュメント内に格納されている content-id URI（cid）参照によって XML ドキュメントコンテンツモデルから参照されます。

  パラメーター:

  am - 設定するアタッチメントマーシャラー

  例外:

  IllegalStateExceptionSE - マーシャル操作中にこのメソッドを同時に呼び出そうとした場合。

• getAttachmentMarshaller

  AttachmentMarshaller getAttachmentMarshaller()

• setSchema

  void setSchema​(SchemaSE schema)

  後続の整列化操作を検証するために使用する必要がある JAXP SchemaSE オブジェクトを指定します。このメソッドに null を渡すと、検証が無効になります。

  このメソッドを使用すると、呼び出し元は、マーシャリングされた XML をマーシャリング時に検証できます。

  最初、このプロパティは null に設定されています。

  パラメーター:

  schema - マーシャル操作を検証するスキーマオブジェクト、または検証を無効にする null

  例外:

  UnsupportedOperationExceptionSE - このメソッドが、JAXB 1.0 マップクラスを参照する JAXBContext から作成されたマーシャラーで呼び出された場合にスローされる可能性があります

  導入:

  1.6、JAXB 2.0

• getSchema

  SchemaSE getSchema()

  整列化時の検証を実行するために使用されている JAXP SchemaSE オブジェクトを取得します。マーシャラーにスキーマが設定されていない場合、このメソッドは null を返し、マーシャル時の検証が実行されないことを示します。

  戻り値:

  マーシャル時間の検証を実行するために使用されているスキーマオブジェクト。存在しない場合は null。

  例外:

  UnsupportedOperationExceptionSE - このメソッドが、JAXB 1.0 マップクラスを参照する JAXBContext から作成されたマーシャラーで呼び出された場合にスローされる可能性があります

  導入:

  1.6、JAXB 2.0

• setListener

  void setListener​(Marshaller.Listener listener)

  マーシャルイベントコールバック Marshaller.Listener をこの Marshaller に登録します。

  マーシャラーごとにリスナーは 1 人だけです。リスナーを設定すると、以前に設定したリスナーが置き換えられます。リスナーを null に設定することにより、現在のリスナーの登録を解除できます。

  パラメーター:

  listener - Marshaller.Listener を実装するクラスのインスタンス

  導入:

  1.6、JAXB 2.0

• getListener

  Marshaller.Listener getListener()

  この Marshaller に登録されている Marshaller.Listener を返します。

  戻り値:

  このマーシャラーにリスナーが登録されていない場合は、Marshaller.Listener または null を登録しました。

  導入:

  1.6、JAXB 2.0