クラス Jaxb2CollectionHttpMessageConverter<T extends CollectionSE>
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
。 このコンバーターは、XmlRootElement
EE および XmlType
EE でアノテーションが付けられたクラスを含むコレクションSEを読み取ることができます。このコンバーターは書き込みをサポートしていないことに注意してください。
- 導入:
- 3.2
- 作成者:
- Arjen Poutsma, Rossen Stoyanchev, Sam Brannen
フィールドのサマリー
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
logger
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明boolean
Jaxb2CollectionHttpMessageConverter はコレクションを読み取るためにジェネリクス型情報を必要としたため、常にfalse
を返します。boolean
指定された型がこのコンバーターで読み取れるかどうかを示します。boolean
Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常にfalse
を返します。boolean
Jaxb2CollectionHttpMessageConverter はコレクションを XML に変換しないため、常にfalse
を返します。protected T
createCollection
(ClassSE<?> collectionClass) 指定された初期容量で、指定された型のコレクションを作成します(コレクション型でサポートされている場合)。protected XMLInputFactorySE
read
(TypeSE type, ClassSE<?> contextClass, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。protected T
readFromSource
(ClassSE<? extends T> clazz, HttpHeaders headers, SourceSE source) AbstractHttpMessageConverter.read(Class, HttpInputMessage)
から呼び出される抽象テンプレートメソッド。protected boolean
指定されたクラスがこのコンバーターでサポートされているかどうかを示します。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 から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes, getSupportedMediaTypes, read, write
コンストラクターの詳細
Jaxb2CollectionHttpMessageConverter
public Jaxb2CollectionHttpMessageConverter()
メソッドの詳細
canRead
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 は、ジェネリクス
Collection
SE を読み取ることができます。ジェネリクス型は、XmlRootElement
EE またはXmlType
EE でアノテーションが付けられた JAXB 型です。- 次で指定:
- インターフェース
GenericHttpMessageConverter<T extends CollectionSE>
のcanRead
- パラメーター:
type
- 読みやすさをテストするための(潜在的に汎用)型contextClass
- ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null
にすることができます)mediaType
- 読み取るメディア型。指定されていない場合はnull
にすることができます。通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canWrite
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
クラスからコピーされた説明: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
指定された初期容量で、指定された型のコレクションを作成します(コレクション型でサポートされている場合)。- パラメーター:
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
クラスからコピーされた説明:AbstractXmlHttpMessageConverter
AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)
から呼び出される抽象テンプレートメソッド。- 次で指定:
- クラス
AbstractXmlHttpMessageConverter<T extends CollectionSE>
のwriteToResult
- パラメーター:
t
- 出力メッセージに書き込むオブジェクトheaders
- HTTP 出力ヘッダーresult
- HTTP 出力本文- 例外:
ExceptionSE
- I/O または変換エラーの場合
createXmlInputFactory
このコンバーターがXMLStreamReader
SE およびXMLEventReader
SE オブジェクトを作成するために使用するXMLInputFactory
を作成します。サブクラスでオーバーライドして、ファクトリの初期化をさらに追加できます。結果のファクトリはキャッシュされるため、このメソッドは 1 回だけ呼び出されます。