Jaxb2CollectionHttpMessageConverter (Spring Framework API)

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

型パラメーター:
T - 変換されたオブジェクト型
実装されているすべてのインターフェース:
GenericHttpMessageConverter<T>, HttpMessageConverter<T>
```
public class Jaxb2CollectionHttpMessageConverter<T extends CollectionSE>
extends AbstractJaxb2HttpMessageConverter<T>
implements GenericHttpMessageConverter<T>
```
JAXB2 を使用して XML コレクションを読み取ることができる HttpMessageConverter。
このコンバーターは、XmlRootElementSE および XmlTypeSE でアノテーションが付けられたクラスを含むコレクションSEを読み取ることができます。このコンバーターは書き込みをサポートしていないことに注意してください。
導入:
3.2
作成者:
Arjen Poutsma, Rossen Stoyanchev

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

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(ClassSE<?> clazz, MediaType mediaType)` Jaxb2CollectionHttpMessageConverter はコレクションを読み取るためにジェネリクス型情報を必要としたため、常に `false` を返します。
`boolean`	`canRead(TypeSE type, ClassSE<?> contextClass, MediaType mediaType)` 指定された型がこのコンバーターで読み取れるかどうかを示します。
`boolean`	`canWrite(ClassSE<?> clazz, MediaType mediaType)` Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常に `false` を返します。
`boolean`	`canWrite(TypeSE type, ClassSE<?> clazz, MediaType mediaType)` Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常に `false` を返します。
`protected T`	`createCollection(ClassSE<?> collectionClass)` 指定された初期容量で、指定された型のコレクションを作成します（コレクション型でサポートされている場合）。
`protected XMLInputFactorySE`	`createXmlInputFactory()` このコンバーターが `XMLStreamReader`SE および `XMLEventReader`SE オブジェクトを作成するために使用する `XMLInputFactory` を作成します。
`T`	`read(TypeSE type, ClassSE<?> contextClass, HttpInputMessage inputMessage)` 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
`protected T`	`readFromSource(ClassSE<? extends T> clazz, HttpHeaders headers, SourceSE source)` `AbstractHttpMessageConverter.read(Class, HttpInputMessage)` から呼び出される抽象テンプレートメソッド。
`protected boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`void`	`write(T t, TypeSE type, MediaType contentType, HttpOutputMessage outputMessage)` 指定されたオブジェクトを指定された出力メッセージに書き込みます。
`protected void`	`writeToResult(T t, 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

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes, getSupportedMediaTypes, read, write

- コンストラクターの詳細
  - Jaxb2CollectionHttpMessageConverter
```
public Jaxb2CollectionHttpMessageConverter()
```
- メソッドの詳細
  - canRead
```
public boolean canRead(ClassSE<?> clazz,
                       @Nullable
                       MediaType mediaType)
```
    Jaxb2CollectionHttpMessageConverter はコレクションを読み取るためにジェネリクス型情報を必要としたため、常に false を返します。
    次で指定:
    インターフェース HttpMessageConverter<T extends CollectionSE> の canRead
    オーバーライド:
    クラス AbstractHttpMessageConverter<T extends CollectionSE> の canRead
    パラメーター:
    clazz - 読み込み可能性をテストするクラス
    mediaType - 読み取るメディア型（指定しない場合は null にできます）; 通常、Content-Type ヘッダーの値。
    戻り値:
    読み取り可能な場合は true。それ以外の場合は false
  - canRead
```
public boolean canRead(TypeSE type,
                       @Nullable
                       ClassSE<?> contextClass,
                       @Nullable
                       MediaType mediaType)
```
    指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、HttpMessageConverter.canRead(Class, MediaType) と同じチェックを実行し、ジェネリクス型に関連する追加のチェックを実行する必要があります。
    Jaxb2CollectionHttpMessageConverter は、ジェネリクス CollectionSE を読み取ることができます。ジェネリクス型は、XmlRootElementSE または XmlTypeSE でアノテーションが付けられた JAXB 型です。
    次で指定:
    インターフェース GenericHttpMessageConverter<T extends CollectionSE> の canRead
    パラメーター:
    type - 読みやすさをテストするための（潜在的に汎用）型
    contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
    mediaType - 読み取るメディア型は、指定しない場合は null にできます。通常、Content-Type ヘッダーの値。
    戻り値:
    読み取り可能な場合は true。それ以外の場合は false
  - canWrite
```
public boolean canWrite(ClassSE<?> clazz,
                        @Nullable
                        MediaType mediaType)
```
    Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常に false を返します。
    次で指定:
    インターフェース HttpMessageConverter<T extends CollectionSE> の canWrite
    オーバーライド:
    クラス AbstractHttpMessageConverter<T extends CollectionSE> の canWrite
    パラメーター:
    clazz - 書き込み可能性をテストするクラス
    mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
    戻り値:
    書き込み可能な場合は true。それ以外の場合は false
  - canWrite
```
public boolean canWrite(@Nullable
                        TypeSE type,
                        @Nullable
                        ClassSE<?> clazz,
                        @Nullable
                        MediaType mediaType)
```
    Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常に false を返します。
    次で指定:
    インターフェース GenericHttpMessageConverter<T extends CollectionSE> の canWrite
    パラメーター:
    type - 書き込み可能かどうかをテストする（潜在的にジェネリクス）型 (指定しない場合は null にすることができます)
    clazz - 書き込み可能性をテストするソースオブジェクトクラス
    mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
    戻り値:
    書き込み可能な場合は true。それ以外の場合は false
  - supports
```
protected boolean supports(ClassSE<?> clazz)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
    次で指定:
    クラス AbstractHttpMessageConverter<T extends CollectionSE> の supports
    パラメーター:
    clazz - サポートをテストするクラス
    戻り値:
    サポートされている場合は true。それ以外の場合は false
  - readFromSource
```
protected T readFromSource(ClassSE<? extends T> clazz,
                           HttpHeaders headers,
                           SourceSE source)
                    throws ExceptionSE
```
    クラスからコピーされた説明: AbstractXmlHttpMessageConverter
    AbstractHttpMessageConverter.read(Class, HttpInputMessage) から呼び出される抽象テンプレートメソッド。
    次で指定:
    クラス AbstractXmlHttpMessageConverter<T extends CollectionSE> の readFromSource
    パラメーター:
    clazz - 返すオブジェクトの型
    headers - HTTP 入力ヘッダー
    source - HTTP 入力本体
    戻り値:
    変換されたオブジェクト
    例外:
    ExceptionSE - I/O または変換エラーの場合
  - read
```
public T read(TypeSE type,
              @Nullable
              ClassSE<?> contextClass,
              HttpInputMessage inputMessage)
       throws IOExceptionSE,
              HttpMessageNotReadableException
```
    インターフェースからコピーされた説明: GenericHttpMessageConverter
    指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
    次で指定:
    インターフェース GenericHttpMessageConverter<T extends CollectionSE> の read
    パラメーター:
    type - 返される（潜在的に汎用の）型のオブジェクト。この型は、このインターフェースの canRead メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
    contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - createCollection
```
protected T createCollection(ClassSE<?> collectionClass)
```
    指定された初期容量で、指定された型のコレクションを作成します（コレクション型でサポートされている場合）。
    パラメーター:
    collectionClass - インスタンス化するコレクションの型
    戻り値:
    作成されたコレクションインスタンス
  - write
```
public void write(T t,
                  @Nullable
                  TypeSE type,
                  @Nullable
                  MediaType contentType,
                  HttpOutputMessage outputMessage)
           throws IOExceptionSE,
                  HttpMessageNotWritableException
```
    インターフェースからコピーされた説明: GenericHttpMessageConverter
    指定されたオブジェクトを指定された出力メッセージに書き込みます。
    次で指定:
    インターフェース GenericHttpMessageConverter<T extends CollectionSE> の write
    パラメーター:
    t - 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースの canWrite メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
    type - 作成する（潜在的にジェネリクスな）型のオブジェクトこの型は、このインターフェースの canWrite メソッドに事前に渡されている必要があり、このメソッドは true を返したはずです。指定しない場合は null になります。
    contentType - 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示す null の場合があります。null でない場合、このメディア型は、このインターフェースの canWrite メソッドに事前に渡されている必要があり、true が返されている必要があります。
    outputMessage - 書き込むメッセージ
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合
  - writeToResult
```
protected void writeToResult(T t,
                             HttpHeaders headers,
                             ResultSE result)
                      throws ExceptionSE
```
    クラスからコピーされた説明: AbstractXmlHttpMessageConverter
    AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage) から呼び出される抽象テンプレートメソッド。
    次で指定:
    クラス AbstractXmlHttpMessageConverter<T extends CollectionSE> の writeToResult
    パラメーター:
    t - 出力メッセージに書き込むオブジェクト
    headers - HTTP 出力ヘッダー
    result - HTTP 出力本文
    例外:
    ExceptionSE - I/O または変換エラーの場合
  - createXmlInputFactory
```
protected XMLInputFactorySE createXmlInputFactory()
```
    このコンバーターが XMLStreamReaderSE および XMLEventReaderSE オブジェクトを作成するために使用する XMLInputFactory を作成します。
    サブクラスでオーバーライドして、ファクトリの初期化をさらに追加できます。結果のファクトリはキャッシュされるため、このメソッドは 1 回だけ呼び出されます。
    関連事項:
    StaxUtils.createDefensiveInputFactory()

クラス Jaxb2CollectionHttpMessageConverter<T extends CollectionSE>

フィールドのサマリー

クラス 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 から継承されたメソッド

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド

コンストラクターの詳細

Jaxb2CollectionHttpMessageConverter

メソッドの詳細

canRead

canRead

canWrite

canWrite

supports

readFromSource

read

createCollection

write

writeToResult

createXmlInputFactory