MarshallingHttpMessageConverter (Spring Framework 5.1.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- - org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter<ObjectSE>
  - - org.springframework.http.converter.xml.MarshallingHttpMessageConverter

実装されたすべてのインターフェース:
HttpMessageConverter<ObjectSE>
```
public class MarshallingHttpMessageConverter
extends AbstractXmlHttpMessageConverter<ObjectSE>
```
Spring の Marshaller および Unmarshaller 抽象化を使用して XML を読み書きできる HttpMessageConverter の実装。
このコンバーターを使用するには、Marshaller および Unmarshaller が必要です。これらは、コンストラクターまたは Bean プロパティによって注入できます。
デフォルトでは、このコンバーターは text/xml および application/xml をサポートしています。これは、supportedMediaTypes プロパティを設定することでオーバーライドできます。
導入:
3.0
作成者:
Arjen Poutsma

フィールドサマリー
- クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
  logger

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`MarshallingHttpMessageConverter()` `Marshaller` または `Unmarshaller` が設定されていない新しい `MarshallingHttpMessageConverter` を作成します。
`MarshallingHttpMessageConverter(Marshaller marshaller)` 指定された `Marshaller` セットで新しい `MarshallingMessageConverter` を構築します。
`MarshallingHttpMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller)` 指定された `Marshaller` および `Unmarshaller` を使用して新しい `MarshallingMessageConverter` を構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(ClassSE<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`boolean`	`canWrite(ClassSE<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`protected ObjectSE`	`readFromSource(ClassSE<?> clazz, HttpHeaders headers, SourceSE source)` `AbstractHttpMessageConverter.read(Class, HttpInputMessage)` から呼び出される抽象テンプレートメソッド。
`void`	`setMarshaller(Marshaller marshaller)` このメッセージコンバーターで使用する `Marshaller` を設定します。
`void`	`setUnmarshaller(Unmarshaller unmarshaller)` このメッセージコンバーターで使用する `Unmarshaller` を設定します。
`protected boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`protected void`	`writeToResult(ObjectSE o, HttpHeaders headers, ResultSE result)` `AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)` から呼び出される抽象テンプレートメソッド。

クラス org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter から継承されたメソッド
readInternal, transform, writeInternal

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

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

- コンストラクターの詳細
  - MarshallingHttpMessageConverter
```
public MarshallingHttpMessageConverter()
```
    Marshaller または Unmarshaller が設定されていない新しい MarshallingHttpMessageConverter を構築します。マーシャラーとアンマーシャラーは、構築後に setMarshaller(Marshaller) および setUnmarshaller(Unmarshaller) を呼び出して設定する必要があります。
  - MarshallingHttpMessageConverter
```
public MarshallingHttpMessageConverter(Marshaller marshaller)
```
    指定された Marshaller セットで新しい MarshallingMessageConverter を構築します。
    指定された Marshaller が Unmarshaller インターフェースも実装している場合、マーシャリングとアンマーシャリングの両方に使用されます。そうでない場合、例外がスローされます。
    Spring のすべての Marshaller 実装も Unmarshaller インターフェースを実装するため、このコンストラクターを安全に使用できることに注意してください。
    パラメーター:
    marshaller - マーシャラーおよびアンマーシャラーとして使用されるオブジェクト
  - MarshallingHttpMessageConverter
```
public MarshallingHttpMessageConverter(Marshaller marshaller,
                                       Unmarshaller unmarshaller)
```
    指定された Marshaller および Unmarshaller を使用して新しい MarshallingMessageConverter を構築します。
    パラメーター:
    marshaller - 使用するマーシャラー
    unmarshaller - 使用するアンマーシャラー
- メソッドの詳細
  - setMarshaller
```
public void setMarshaller(Marshaller marshaller)
```
    このメッセージコンバーターで使用する Marshaller を設定します。
  - setUnmarshaller
```
public void setUnmarshaller(Unmarshaller unmarshaller)
```
    このメッセージコンバーターで使用する Unmarshaller を設定します。
  - canRead
```
public boolean canRead(ClassSE<?> clazz,
                       @Nullable
                       MediaType mediaType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
    次で指定:
    インターフェース HttpMessageConverter<ObjectSE> の canRead
    オーバーライド:
    クラス AbstractHttpMessageConverter<ObjectSE> の canRead
    パラメーター:
    clazz - 読み込み可能性をテストするクラス
    mediaType - 読み取るメディア型（指定しない場合は null にできます）; 通常、Content-Type ヘッダーの値。
    戻り値:
    読み取り可能な場合は true。それ以外の場合は false
  - canWrite
```
public boolean canWrite(ClassSE<?> clazz,
                        @Nullable
                        MediaType mediaType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
    次で指定:
    インターフェース HttpMessageConverter<ObjectSE> の canWrite
    オーバーライド:
    クラス AbstractHttpMessageConverter<ObjectSE> の canWrite
    パラメーター:
    clazz - 書き込み可能性をテストするクラス
    mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
    戻り値:
    書き込み可能な場合は true。それ以外の場合は false
  - supports
```
protected boolean supports(ClassSE<?> clazz)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
    次で指定:
    クラス AbstractHttpMessageConverter<ObjectSE> の supports
    パラメーター:
    clazz - サポートをテストするクラス
    戻り値:
    サポートされている場合は true。それ以外の場合は false
  - readFromSource
```
protected ObjectSE readFromSource(ClassSE<?> clazz,
                                HttpHeaders headers,
                                SourceSE source)
                         throws ExceptionSE
```
    クラスからコピーされた説明: AbstractXmlHttpMessageConverter
    AbstractHttpMessageConverter.read(Class, HttpInputMessage) から呼び出される抽象テンプレートメソッド。
    次で指定:
    クラス AbstractXmlHttpMessageConverter<ObjectSE> の readFromSource
    パラメーター:
    clazz - 返すオブジェクトの型
    headers - HTTP 入力ヘッダー
    source - HTTP 入力本体
    戻り値:
    変換されたオブジェクト
    例外:
    ExceptionSE - I/O または変換エラーの場合
  - writeToResult
```
protected void writeToResult(ObjectSE o,
                             HttpHeaders headers,
                             ResultSE result)
                      throws ExceptionSE
```
    クラスからコピーされた説明: AbstractXmlHttpMessageConverter
    AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage) から呼び出される抽象テンプレートメソッド。
    次で指定:
    クラス AbstractXmlHttpMessageConverter<ObjectSE> の writeToResult
    パラメーター:
    o - 出力メッセージに書き込むオブジェクト
    headers - HTTP 出力ヘッダー
    result - HTTP 出力本文
    例外:
    ExceptionSE - I/O または変換エラーの場合

クラス MarshallingHttpMessageConverter

フィールドサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter から継承されたメソッド

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド

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

コンストラクターの詳細

MarshallingHttpMessageConverter

MarshallingHttpMessageConverter

MarshallingHttpMessageConverter

メソッドの詳細

setMarshaller

setUnmarshaller

canRead

canWrite

supports

readFromSource

writeToResult