public class BufferedImageHttpMessageConverter extends java.lang.Object implements HttpMessageConverter<java.awt.image.BufferedImage>
BufferedImages を読み書きできる HttpMessageConverter の実装。 デフォルトでは、このコンバーターは、登録されたイメージリーダーでサポートされているすべてのメディア型を読み取り、最初に利用可能な登録済みのイメージライターのメディア型を使用して書き込むことができます。後者は、defaultContentType プロパティを設定することでオーバーライドできます。
cacheDir プロパティが設定されている場合、このコンバーターはイメージデータをキャッシュします。
process(ImageReadParam) および process(ImageWriteParam) テンプレートメソッドを使用すると、サブクラスでイメージ I/O パラメーターをオーバーライドできます。
| コンストラクターと説明 |
|---|
BufferedImageHttpMessageConverter() |
| 修飾子と型 | メソッドと説明 |
|---|---|
boolean | canRead(java.lang.Class<?> clazz, MediaType mediaType) 指定されたクラスがこのコンバーターで読み取れるかどうかを示します。 |
boolean | canWrite(java.lang.Class<?> clazz, MediaType mediaType) 指定されたクラスをこのコンバーターで書き込めるかどうかを示します。 |
MediaType | getDefaultContentType() 書き込みに使用されるデフォルト Content-Type を返します。 |
java.util.List<MediaType> | getSupportedMediaTypes() このコンバーターがサポートする MediaType オブジェクトのリストを返します。 |
protected void | process(javax.imageio.ImageReadParam irp) イメージの読み取りに使用する前に ImageReadParam を操作できるテンプレートメソッド。 |
protected void | process(javax.imageio.ImageWriteParam iwp) イメージの書き込みに使用する前に ImageWriteParam を操作できるテンプレートメソッド。 |
java.awt.image.BufferedImage | read(java.lang.Class<? extends java.awt.image.BufferedImage> clazz, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。 |
void | setCacheDir(java.io.File cacheDir) キャッシュディレクトリを設定します。 |
void | setDefaultContentType(MediaType defaultContentType) 書き込みに使用されるデフォルトの Content-Type を設定します。 |
void | write(java.awt.image.BufferedImage image, MediaType contentType, HttpOutputMessage outputMessage) 指定されたオブジェクトを指定された出力メッセージに書き込みます。 |
public void setDefaultContentType(@Nullable MediaType defaultContentType)
Content-Type を設定します。java.lang.IllegalArgumentException - 指定されたコンテンツ型が 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(java.io.File cacheDir)
public boolean canRead(java.lang.Class<?> clazz,
@Nullable
MediaType mediaType)HttpMessageConverterHttpMessageConverter<java.awt.image.BufferedImage> 内の canRead clazz - 読み込み可能性をテストするクラス mediaType - 読み取るメディア型(指定しない場合は null にできます); 通常、Content-Type ヘッダーの値。true。それ以外の場合は false public boolean canWrite(java.lang.Class<?> clazz,
@Nullable
MediaType mediaType)HttpMessageConverterHttpMessageConverter<java.awt.image.BufferedImage> 内の canWrite clazz - 書き込み可能性をテストするクラス mediaType - 書き込むメディア型(指定しない場合は null にすることができます); 通常、Accept ヘッダーの値。true。それ以外の場合は false public java.util.List<MediaType> getSupportedMediaTypes()
HttpMessageConverterMediaType オブジェクトのリストを返します。HttpMessageConverter<java.awt.image.BufferedImage> 内の getSupportedMediaTypes public java.awt.image.BufferedImage read(@Nullable java.lang.Class<? extends java.awt.image.BufferedImage> clazz, HttpInputMessage inputMessage) throws java.io.IOException, HttpMessageNotReadableException
HttpMessageConverterHttpMessageConverter<java.awt.image.BufferedImage> 内の read clazz - 返すオブジェクトの型。この型は、このインターフェースの canRead メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。inputMessage - 読み込む HTTP 入力メッセージ java.io.IOException - I/O エラーの場合 HttpMessageNotReadableException - 変換エラーの場合 public void write(java.awt.image.BufferedImage image,
@Nullable
MediaType contentType,
HttpOutputMessage outputMessage)
throws java.io.IOException,
HttpMessageNotWritableExceptionHttpMessageConverterHttpMessageConverter<java.awt.image.BufferedImage> 内の write image - 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースの canWrite メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。contentType - 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示す null の場合があります。null でない場合、このメディア型は、このインターフェースの canWrite メソッドに事前に渡されている必要があり、true が返されている必要があります。outputMessage - 書き込むメッセージ java.io.IOException - I/O エラーの場合 HttpMessageNotWritableException - 変換エラーの場合 protected void process(javax.imageio.ImageReadParam irp)
ImageReadParam を操作できるテンプレートメソッド。デフォルトの実装は空です。
protected void process(javax.imageio.ImageWriteParam iwp)
ImageWriteParam を操作できるテンプレートメソッド。デフォルトの実装は空です。