ResourceHttpMessageConverter (Spring Framework 5.1.5.RELEASE API)

java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<Resource>
- - org.springframework.http.converter.ResourceHttpMessageConverter

実装されたすべてのインターフェース:
HttpMessageConverter<Resource>
```
public class ResourceHttpMessageConverter
extends AbstractHttpMessageConverter<Resource>
```
Resources の読み取り / 書き込みが可能で、バイト範囲リクエストをサポートする HttpMessageConverter の実装。
デフォルトでは、このコンバーターはすべてのメディア型を読み取ることができます。MediaTypeFactory は、書き込まれたリソースの Content-Type を判別するために使用されます。
導入:
3.0.2
作成者:
Arjen Poutsma, Juergen Hoeller, Kazuki Shimizu

フィールドのサマリー
- クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
  logger

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ResourceHttpMessageConverter()` 読み取りストリーミングをサポートする `ResourceHttpMessageConverter` の新しいインスタンスを作成します。
`ResourceHttpMessageConverter(boolean supportsReadStreaming)` `ResourceHttpMessageConverter` の新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected java.lang.Long`	`getContentLength(Resource resource, MediaType contentType)` 指定された型のコンテンツの長さを返します。
`protected MediaType`	`getDefaultContentType(Resource resource)` 指定された型のデフォルトのコンテンツ型を返します。
`protected Resource`	`readInternal(java.lang.Class<? extends Resource> clazz, HttpInputMessage inputMessage)` 実際のオブジェクトを読み取る抽象テンプレートメソッド。
`protected boolean`	`supports(java.lang.Class<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`protected void`	`writeContent(Resource resource, HttpOutputMessage outputMessage)`
`protected void`	`writeInternal(Resource resource, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - ResourceHttpMessageConverter
```
public ResourceHttpMessageConverter()
```
    読み取りストリーミングをサポートする ResourceHttpMessageConverter の新しいインスタンスを作成します。つまり、HttpInputMessage を InputStreamResource に変換できます。
  - ResourceHttpMessageConverter
```
public ResourceHttpMessageConverter(boolean supportsReadStreaming)
```
    ResourceHttpMessageConverter の新しいインスタンスを作成します。
    パラメーター:
    supportsReadStreaming - コンバーターが読み取りストリーミングをサポートするかどうか、つまり InputStreamResource に変換するかどうか
    導入:
    5.0
- メソッドの詳細
  - supports
```
protected boolean supports(java.lang.Class<?> clazz)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
    次で指定:
    クラス AbstractHttpMessageConverter<Resource> の supports
    パラメーター:
    clazz - サポートをテストするクラス
    戻り値:
    サポートされている場合は true。それ以外の場合は false
  - readInternal
```
protected Resource readInternal(java.lang.Class<? extends Resource> clazz,
                                HttpInputMessage inputMessage)
                         throws java.io.IOException,
                                HttpMessageNotReadableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<Resource> の readInternal
    パラメーター:
    clazz - 返すオブジェクトの型
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    java.io.IOException - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - getDefaultContentType
```
protected MediaType getDefaultContentType(Resource resource)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のデフォルトのコンテンツ型を返します。指定されたコンテンツ型パラメーターなしで AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) が呼び出されたときに呼び出されます。
    デフォルトでは、supportedMediaTypes プロパティの最初の要素があれば、それを返します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<Resource> の getDefaultContentType
    パラメーター:
    resource - コンテンツ型を返す型
    戻り値:
    コンテンツ型、または不明の場合は null
  - getContentLength
```
protected java.lang.Long getContentLength(Resource resource,
                                          @Nullable
                                          MediaType contentType)
                                   throws java.io.IOException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のコンテンツの長さを返します。
    デフォルトでは、これは null を返します。これは、コンテンツの長さが不明であることを意味します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<Resource> の getContentLength
    パラメーター:
    resource - コンテンツの長さを返す型
    戻り値:
    コンテンツの長さ、または不明の場合は null
    例外:
    java.io.IOException
  - writeInternal
```
protected void writeInternal(Resource resource,
                             HttpOutputMessage outputMessage)
                      throws java.io.IOException,
                             HttpMessageNotWritableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<Resource> の writeInternal
    パラメーター:
    resource - 出力メッセージに書き込むオブジェクト
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    java.io.IOException - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合
  - writeContent
```
protected void writeContent(Resource resource,
                            HttpOutputMessage outputMessage)
                     throws java.io.IOException,
                            HttpMessageNotWritableException
```
    例外:
    java.io.IOException
    HttpMessageNotWritableException

クラス ResourceHttpMessageConverter

フィールドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

ResourceHttpMessageConverter

ResourceHttpMessageConverter

メソッドの詳細

supports

readInternal

getDefaultContentType

getContentLength

writeInternal

writeContent