クラス BufferedImageHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.BufferedImageHttpMessageConverter
- 実装されたすべてのインターフェース:
HttpMessageConverter<BufferedImageSE>
public class BufferedImageHttpMessageConverter
extends ObjectSE
implements HttpMessageConverter<BufferedImageSE>
BufferedImages
SE を読み書きできる HttpMessageConverter
の実装。デフォルトでは、このコンバーターは、登録済みイメージリーダーでサポートされているすべてのメディア型を読み取り、最初に使用可能な登録済みイメージライターのメディア型を使用して書き込みを行うことができます。後者は、defaultContentType
プロパティを設定することでオーバーライドできます。
cacheDir
プロパティが設定されている場合、このコンバーターはイメージデータをキャッシュします。
process(ImageReadParam)
および process(ImageWriteParam)
テンプレートメソッドを使用すると、サブクラスでイメージ I/O パラメーターをオーバーライドできます。
- 導入:
- 3.0
- 作成者:
- Arjen Poutsma
コンストラクターのサマリー
方法の概要
修飾子と型メソッド説明boolean
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。boolean
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。書き込みに使用されるデフォルトContent-Type
を返します。このコンバーターでサポートされているメディア型のリストを返します。protected void
process
(ImageReadParamSE irp) イメージの読み取りに使用する前にImageReadParam
SE を操作できるテンプレートメソッド。protected void
process
(ImageWriteParamSE iwp) イメージの書き込みに使用する前にImageWriteParam
SE を操作できるテンプレートメソッド。read
(ClassSE<? extends BufferedImageSE> clazz, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。void
setCacheDir
(FileSE cacheDir) キャッシュディレクトリを設定します。void
setDefaultContentType
(MediaType defaultContentType) 書き込みに使用されるデフォルトのContent-Type
を設定します。void
write
(BufferedImageSE image, MediaType contentType, HttpOutputMessage outputMessage) 指定されたオブジェクトを指定された出力メッセージに書き込みます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes
コンストラクターの詳細
BufferedImageHttpMessageConverter
public BufferedImageHttpMessageConverter()
メソッドの詳細
setDefaultContentType
書き込みに使用されるデフォルトのContent-Type
を設定します。- 例外:
IllegalArgumentExceptionSE
- 指定されたコンテンツ型が Java Image I/O API でサポートされていない場合
getDefaultContentType
書き込みに使用するデフォルトのContent-Type
を返します。コンテンツ型パラメーターを指定せずにwrite(java.awt.image.BufferedImage, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
が呼び出されたときに呼び出されます。setCacheDir
キャッシュディレクトリを設定します。このプロパティが既存のディレクトリに設定されている場合、このコンバーターはイメージデータをキャッシュします。canRead
インターフェースからコピーされた説明:HttpMessageConverter
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。- 次で指定:
- インターフェース
HttpMessageConverter<BufferedImageSE>
のcanRead
- パラメーター:
clazz
- 読み込み可能性をテストするクラスmediaType
- 読み取るメディア型(指定しない場合はnull
にできます); 通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canWrite
インターフェースからコピーされた説明:HttpMessageConverter
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。- 次で指定:
- インターフェース
HttpMessageConverter<BufferedImageSE>
のcanWrite
- パラメーター:
clazz
- 書き込み可能性をテストするクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
getSupportedMediaTypes
インターフェースからコピーされた説明:HttpMessageConverter
このコンバーターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(clazz, null
を介して保護する必要があります。このリストでは、特定のクラスでのみサポートされている MIME 型を除外することもできます。または、HttpMessageConverter.getSupportedMediaTypes(Class)
を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
HttpMessageConverter<BufferedImageSE>
のgetSupportedMediaTypes
- 戻り値:
- サポートされているメディア型のリスト
read
public BufferedImageSE read(@Nullable ClassSE<? extends BufferedImageSE> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException インターフェースからコピーされた説明:HttpMessageConverter
指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。- 次で指定:
- インターフェース
HttpMessageConverter<BufferedImageSE>
のread
- パラメーター:
clazz
- 返すオブジェクトの型。この型は、このインターフェースのcanRead
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
write
public void write(BufferedImageSE image, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException インターフェースからコピーされた説明:HttpMessageConverter
指定されたオブジェクトを指定された出力メッセージに書き込みます。- 次で指定:
- インターフェース
HttpMessageConverter<BufferedImageSE>
のwrite
- パラメーター:
image
- 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。contentType
- 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示すnull
の場合があります。null
でない場合、このメディア型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があり、true
が返されている必要があります。outputMessage
- 書き込むメッセージ- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合
process
イメージの読み取りに使用する前にImageReadParam
SE を操作できるテンプレートメソッド。デフォルトの実装は空です。
process
イメージの書き込みに使用する前にImageWriteParam
SE を操作できるテンプレートメソッド。デフォルトの実装は空です。