public class BufferedImageHttpMessageConverter extends ObjectSE implements HttpMessageConverter<BufferedImageSE>
BufferedImages
SE を読み書きできる HttpMessageConverter
の実装。デフォルトでは、このコンバーターは、登録済みイメージリーダーSEでサポートされているすべてのメディア型を読み取り、最初に使用可能な登録済みイメージライターSEのメディア型を使用して書き込みを行うことができます。後者は、defaultContentType
プロパティを設定することでオーバーライドできます。
cacheDir
プロパティが設定されている場合、このコンバーターはイメージデータをキャッシュします。
process(ImageReadParam)
および process(ImageWriteParam)
テンプレートメソッドを使用すると、サブクラスでイメージ I/O パラメーターをオーバーライドできます。
コンストラクターと説明 |
---|
BufferedImageHttpMessageConverter() |
修飾子と型 | メソッドと説明 |
---|---|
boolean | canRead(ClassSE<?> clazz, MediaType mediaType) 指定されたクラスがこのコンバーターで読み取れるかどうかを示します。 |
boolean | canWrite(ClassSE<?> clazz, MediaType mediaType) 指定されたクラスをこのコンバーターで書き込めるかどうかを示します。 |
MediaType | getDefaultContentType() 書き込みに使用されるデフォルト Content-Type を返します。 |
ListSE<MediaType> | getSupportedMediaTypes() このコンバーターでサポートされているメディア型のリストを返します。 |
protected void | process(ImageReadParamSE irp) イメージの読み取りに使用する前に ImageReadParam SE を操作できるテンプレートメソッド。 |
protected void | process(ImageWriteParamSE iwp) イメージの書き込みに使用する前に ImageWriteParam SE を操作できるテンプレートメソッド。 |
BufferedImageSE | 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) 指定されたオブジェクトを指定された出力メッセージに書き込みます。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
getSupportedMediaTypes
public void setDefaultContentType(@Nullable MediaType defaultContentType)
Content-Type
を設定します。IllegalArgumentExceptionSE
- 指定されたコンテンツ型が Java Image I/O API でサポートされていない場合 @Nullable public MediaType getDefaultContentType()
Content-Type
を返します。コンテンツ型パラメーターを指定せずに write(java.awt.image.BufferedImage, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
が呼び出されたときに呼び出されます。public void setCacheDir(FileSE cacheDir)
public boolean canRead(ClassSE<?> clazz, @Nullable MediaType mediaType)
HttpMessageConverter
HttpMessageConverter<BufferedImageSE>
の canRead
clazz
- 読み込み可能性をテストするクラス mediaType
- 読み取るメディア型(指定しない場合は null
にできます); 通常、Content-Type
ヘッダーの値。true
。それ以外の場合は false
public boolean canWrite(ClassSE<?> clazz, @Nullable MediaType mediaType)
HttpMessageConverter
HttpMessageConverter<BufferedImageSE>
の canWrite
clazz
- 書き込み可能性をテストするクラス mediaType
- 書き込むメディア型(指定しない場合は null
にすることができます); 通常、Accept
ヘッダーの値。true
。それ以外の場合は false
public ListSE<MediaType> getSupportedMediaTypes()
HttpMessageConverter
canWrite(clazz, null
を介して保護する必要があります。このリストでは、特定のクラスでのみサポートされている MIME 型を除外することもできます。または、HttpMessageConverter.getSupportedMediaTypes(Class)
を使用してより正確なリストを作成します。HttpMessageConverter<BufferedImageSE>
の getSupportedMediaTypes
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
- 変換エラーの場合 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
- 変換エラーの場合 protected void process(ImageReadParamSE irp)
ImageReadParam
SE を操作できるテンプレートメソッド。デフォルトの実装は空です。
protected void process(ImageWriteParamSE iwp)
ImageWriteParam
SE を操作できるテンプレートメソッド。デフォルトの実装は空です。