AbstractXmlHttpMessageConverter (Spring Framework 5.2.8.RELEASE API)

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

型パラメーター:
T - 変換されたオブジェクト型
実装されているすべてのインターフェース:
HttpMessageConverter<T>
既知の直属サブクラス
AbstractJaxb2HttpMessageConverter, MarshallingHttpMessageConverter
```
public abstract class AbstractXmlHttpMessageConverter<T>
extends AbstractHttpMessageConverter<T>
```
XML との間で変換を行う HttpMessageConverters の抽象基本クラス。
デフォルトでは、このコンバーターのサブクラスは text/xml、application/xml、application/*-xml をサポートします。これは、supportedMediaTypes プロパティを設定することで上書きできます。
導入:
3.0
作成者:
Arjen Poutsma, Juergen Hoeller

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

コンストラクターの概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractXmlHttpMessageConverter()` `supportedMediaTypes` を `text/xml` と `application/xml`、および `application/*-xml` に設定する protected コンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected abstract T`	`readFromSource(ClassSE<? extends T> clazz, HttpHeaders headers, SourceSE source)` `AbstractHttpMessageConverter.read(Class, HttpInputMessage)` から呼び出される抽象テンプレートメソッド。
`T`	`readInternal(ClassSE<? extends T> clazz, HttpInputMessage inputMessage)` 実際のオブジェクトを読み取る抽象テンプレートメソッド。
`protected void`	`transform(SourceSE source, ResultSE result)` 指定された `Source` を `Result` に変換します。
`protected void`	`writeInternal(T t, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。
`protected abstract void`	`writeToResult(T t, HttpHeaders headers, ResultSE result)` `writeInternal(Object, HttpOutputMessage)` から呼び出される抽象テンプレートメソッド。

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

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

- コンストラクターの詳細
  - AbstractXmlHttpMessageConverter
```
protected AbstractXmlHttpMessageConverter()
```
    supportedMediaTypes を text/xml と application/xml、および application/*-xml に設定する protected コンストラクター。
- メソッドの詳細
  - readInternal
```
public final T readInternal(ClassSE<? extends T> clazz,
                            HttpInputMessage inputMessage)
                     throws IOExceptionSE,
                            HttpMessageNotReadableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<T> の readInternal
    パラメーター:
    clazz - 返すオブジェクトの型
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - writeInternal
```
protected final void writeInternal(T t,
                                   HttpOutputMessage outputMessage)
                            throws IOExceptionSE,
                                   HttpMessageNotWritableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<T> の writeInternal
    パラメーター:
    t - 出力メッセージに書き込むオブジェクト
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合
  - transform
```
protected void transform(SourceSE source,
                         ResultSE result)
                  throws TransformerExceptionSE
```
    指定された Source を Result に変換します。
    パラメーター:
    source - 変換元
    result - 変換する結果
    例外:
    TransformerExceptionSE - 変換エラーの場合
  - readFromSource
```
protected abstract T readFromSource(ClassSE<? extends T> clazz,
                                    HttpHeaders headers,
                                    SourceSE source)
                             throws ExceptionSE
```
    AbstractHttpMessageConverter.read(Class, HttpInputMessage) から呼び出される抽象テンプレートメソッド。
    パラメーター:
    clazz - 返すオブジェクトの型
    headers - HTTP 入力ヘッダー
    source - HTTP 入力本体
    戻り値:
    変換されたオブジェクト
    例外:
    ExceptionSE - I/O または変換エラーの場合
  - writeToResult
```
protected abstract void writeToResult(T t,
                                      HttpHeaders headers,
                                      ResultSE result)
                               throws ExceptionSE
```
    writeInternal(Object, HttpOutputMessage) から呼び出される抽象テンプレートメソッド。
    パラメーター:
    t - 出力メッセージに書き込むオブジェクト
    headers - HTTP 出力ヘッダー
    result - HTTP 出力本文
    例外:
    ExceptionSE - I/O または変換エラーの場合

クラス AbstractXmlHttpMessageConverter<T>

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

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

コンストラクターの詳細

AbstractXmlHttpMessageConverter

メソッドの詳細

readInternal

writeInternal

transform

readFromSource

writeToResult