Jaxb2RootElementHttpMessageConverter (Spring Framework 5.2.5.RELEASE API)

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

実装されたすべてのインターフェース:
HttpMessageConverter<ObjectSE>
```
public class Jaxb2RootElementHttpMessageConverter
extends AbstractJaxb2HttpMessageConverter<ObjectSE>
```
JAXB2 を使用して XML を読み書きできる HttpMessageConverter の実装。
このコンバーターは、XmlRootElementSE および XmlTypeSE のアノテーションが付いたクラスを読み取り、XmlRootElementSE のアノテーションが付いたクラスまたはそのサブクラスを書き込むことができます。
メモ: spring-oxm から Spring の Marshaller/Unmarshaller 抽象化を使用する場合、代わりに MarshallingHttpMessageConverter を使用する必要があります。
導入:
3.0
作成者:
Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev
関連事項:
MarshallingHttpMessageConverter

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

コンストラクターの概要
コンストラクター
コンストラクターと説明
Jaxb2RootElementHttpMessageConverter()

コンストラクター
コンストラクターと説明
`Jaxb2RootElementHttpMessageConverter()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(ClassSE<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`boolean`	`canWrite(ClassSE<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`boolean`	`isProcessExternalEntities()` XML 外部エンティティが許可されているかどうかを返します。
`boolean`	`isSupportDtd()` DTD 解析がサポートされているかどうかを返します。
`protected SourceSE`	`processSource(SourceSE source)`
`protected ObjectSE`	`readFromSource(ClassSE<?> clazz, HttpHeaders headers, SourceSE source)` `AbstractHttpMessageConverter.read(Class, HttpInputMessage)` から呼び出される抽象テンプレートメソッド。
`void`	`setProcessExternalEntities(boolean processExternalEntities)` Source への変換時に外部 XML エンティティが処理されるかどうかを示します。
`void`	`setSupportDtd(boolean supportDtd)` DTD 解析をサポートする必要があるかどうかを示します。
`protected boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`protected void`	`writeToResult(ObjectSE o, HttpHeaders headers, ResultSE result)` `AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)` から呼び出される抽象テンプレートメソッド。

クラス org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter から継承されたメソッド
createMarshaller, createUnmarshaller, customizeMarshaller, customizeUnmarshaller, getJaxbContext

クラス 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

- コンストラクターの詳細
  - Jaxb2RootElementHttpMessageConverter
```
public Jaxb2RootElementHttpMessageConverter()
```
- メソッドの詳細
  - setSupportDtd
```
public void setSupportDtd(boolean supportDtd)
```
    DTD 解析をサポートする必要があるかどうかを示します。
    デフォルトは false で、DTD が無効になっています。
  - isSupportDtd
```
public boolean isSupportDtd()
```
    DTD 解析がサポートされているかどうかを返します。
  - setProcessExternalEntities
```
public void setProcessExternalEntities(boolean processExternalEntities)
```
    Source への変換時に外部 XML エンティティが処理されるかどうかを示します。
    デフォルトは false です。これは、外部エンティティが解決されないことを意味します。
    注意 : このオプションを true に設定すると、setSupportDtd(boolean) が true に自動的に設定されます。
  - isProcessExternalEntities
```
public boolean isProcessExternalEntities()
```
    XML 外部エンティティが許可されているかどうかを返します。
  - 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 または変換エラーの場合
  - processSource
```
protected SourceSE processSource(SourceSE source)
```
  - 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 または変換エラーの場合

クラス Jaxb2RootElementHttpMessageConverter

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

Jaxb2RootElementHttpMessageConverter

メソッドの詳細

setSupportDtd

isSupportDtd

setProcessExternalEntities

isProcessExternalEntities

canRead

canWrite

supports

readFromSource

processSource

writeToResult