クラス 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
  • コンストラクターの詳細

    • BufferedImageHttpMessageConverter

      public BufferedImageHttpMessageConverter()
  • メソッドの詳細

    • setDefaultContentType

      public void setDefaultContentType(@Nullable MediaType defaultContentType)
      書き込みに使用されるデフォルトの Content-Type を設定します。
      例外:
      IllegalArgumentExceptionSE - 指定されたコンテンツ型が Java Image I/O API でサポートされていない場合
    • getDefaultContentType

      @Nullable public MediaType getDefaultContentType()
      書き込みに使用するデフォルトの Content-Type を返します。コンテンツ型パラメーターを指定せずに write(java.awt.image.BufferedImage, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) が呼び出されたときに呼び出されます。
    • setCacheDir

      public void setCacheDir(FileSE cacheDir)
      キャッシュディレクトリを設定します。このプロパティが既存のディレクトリに設定されている場合、このコンバーターはイメージデータをキャッシュします。
    • canRead

      public boolean canRead(ClassSE<?> clazz, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: HttpMessageConverter
      指定されたクラスがこのコンバーターで読み取れるかどうかを示します。
      次で指定:
      インターフェース HttpMessageConverter<BufferedImageSE>canRead 
      パラメーター:
      clazz - 読み込み可能性をテストするクラス
      mediaType - 読み取るメディア型(指定しない場合は null にできます); 通常、Content-Type ヘッダーの値。
      戻り値:
      読み取り可能な場合は true。それ以外の場合は false 
    • canWrite

      public boolean canWrite(ClassSE<?> clazz, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: HttpMessageConverter
      指定されたクラスをこのコンバーターで書き込めるかどうかを示します。
      次で指定:
      インターフェース HttpMessageConverter<BufferedImageSE>canWrite 
      パラメーター:
      clazz - 書き込み可能性をテストするクラス
      mediaType - 書き込むメディア型(指定しない場合は null にすることができます); 通常、Accept ヘッダーの値。
      戻り値:
      書き込み可能な場合は true。それ以外の場合は false 
    • getSupportedMediaTypes

      public ListSE<MediaType> getSupportedMediaTypes()
      インターフェースからコピーされた説明: HttpMessageConverter
      このコンバーターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(clazz, null を介して保護する必要があります。このリストでは、特定のクラスでのみサポートされている MIME 型を除外することもできます。または、HttpMessageConverter.getSupportedMediaTypes(Class) を使用してより正確なリストを作成します。
      次で指定:
      インターフェース HttpMessageConverter<BufferedImageSE>getSupportedMediaTypes 
      戻り値:
      サポートされているメディア型のリスト
    • read

      インターフェースからコピーされた説明: 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

      protected void process(ImageReadParamSE irp)
      イメージの読み取りに使用する前に ImageReadParamSE を操作できるテンプレートメソッド。

      デフォルトの実装は空です。

    • process

      protected void process(ImageWriteParamSE iwp)
      イメージの書き込みに使用する前に ImageWriteParamSE を操作できるテンプレートメソッド。

      デフォルトの実装は空です。