クラス BufferedImageHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.BufferedImageHttpMessageConverter
- 実装されているすべてのインターフェース:
- HttpMessageConverter<BufferedImageSE>
public class BufferedImageHttpMessageConverter
extends ObjectSE
implements HttpMessageConverter<BufferedImageSE>
BufferedImagesSE を読み書きできる HttpMessageConverter の実装。デフォルトでは、このコンバーターは、登録済みイメージリーダーでサポートされているすべてのメディア型を読み取り、最初に使用可能な登録済みイメージライターのメディア型を使用して書き込みを行うことができます。後者は、defaultContentType プロパティを設定することでオーバーライドできます。
cacheDir プロパティが設定されている場合、このコンバーターはイメージデータをキャッシュします。
process(ImageReadParam) および process(ImageWriteParam) テンプレートメソッドを使用すると、サブクラスでイメージ I/O パラメーターをオーバーライドできます。
- 導入:
- 3.0
- 作成者:
- Arjen Poutsma
- コンストラクターの概要コンストラクター
- メソッドのサマリー修飾子と型メソッド説明- boolean指定されたクラスがこのコンバーターで読み取れるかどうかを示します。- boolean指定されたクラスをこのコンバーターで書き込めるかどうかを示します。書き込みに使用されるデフォルト- Content-Typeを返します。このコンバーターでサポートされているメディア型のリストを返します。- protected void- process- (ImageReadParamSE irp) イメージの読み取りに使用する前に- ImageReadParamSE を操作できるテンプレートメソッド。- protected void- process- (ImageWriteParamSE iwp) イメージの書き込みに使用する前に- ImageWriteParamSE を操作できるテンプレートメソッド。- 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
- コンストラクターの詳細- BufferedImageHttpMessageConverterpublic 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
- 戻り値:
- サポートされているメディア型のリスト
 
- readpublic 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- 変換エラーの場合
 
- writepublic 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イメージの読み取りに使用する前に- ImageReadParamSE を操作できるテンプレートメソッド。- デフォルトの実装は空です。 
- processイメージの書き込みに使用する前に- ImageWriteParamSE を操作できるテンプレートメソッド。- デフォルトの実装は空です。