Resource (Spring Framework API)

すべてのスーパーインターフェース:
InputStreamSource
すべての既知のサブインターフェース:
ContextResource, HttpResource, HttpResource, WritableResource
すべての既知の実装クラス:
AbstractFileResolvingResource, AbstractResource, ByteArrayResource, ClassPathResource, DefaultResourceLoader.ClassPathContextResource, DescriptiveResource, FileSystemResource, FileUrlResource, InputStreamResource, PathResource, ServletContextResource, TransformedResource, TransformedResource, UrlResource, VfsResource
```
public interface Resource
extends InputStreamSource
```
ファイルやクラスパスリソースなど、基礎となるリソースの実際の型から抽象化するリソース記述子のインターフェース。
InputStream は、物理的な形式で存在する場合、すべてのリソースに対して開くことができますが、URL またはファイルハンドルは特定のリソースに対してのみ返すことができます。実際の動作は実装固有です。
導入:
28.12.2003
作成者:
Juergen Hoeller
関連事項:
InputStreamSource.getInputStream(), getURL(), getURI(), getFile(), WritableResource, ContextResource, UrlResource, FileUrlResource, FileSystemResource, ClassPathResource, ByteArrayResource, InputStreamResource

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`long`	`contentLength()` このリソースのコンテンツの長さを決定します。
`Resource`	`createRelative(StringSE relativePath)` このリソースに関連するリソースを作成します。
`boolean`	`exists()` このリソースが実際に物理的な形で存在するかどうかを判断します。
`StringSE`	`getDescription()` このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。
`FileSE`	`getFile()` このリソースのファイルハンドルを返します。
`StringSE`	`getFilename()` このリソースのファイル名、つまり
`URISE`	`getURI()` このリソースの URI ハンドルを返します。
`URLSE`	`getURL()` このリソースの URL ハンドルを返します。
`default boolean`	`isFile()` このリソースがファイルシステム内のファイルを表すかどうかを判断します。
`default boolean`	`isOpen()` このリソースがオープンストリームのハンドルを表すかどうかを示します。
`default boolean`	`isReadable()` このリソースの空でないコンテンツを `InputStreamSource.getInputStream()` を介して読み取ることができるかどうかを示します。
`long`	`lastModified()` このリソースの最終変更タイムスタンプを決定します。
`default ReadableByteChannelSE`	`readableChannel()` `ReadableByteChannel`SE を返します。

インターフェース org.springframework.core.io.InputStreamSource から継承されたメソッド
getInputStream

- メソッドの詳細
  - exists
```
boolean exists()
```
    このリソースが実際に物理的な形で存在するかどうかを判断します。
    このメソッドは最終的な存在チェックを実行しますが、Resource ハンドルの存在は有効な記述子ハンドルのみを保証します。
  - isReadable
```
default boolean isReadable()
```
    このリソースの空でないコンテンツを InputStreamSource.getInputStream() を介して読み取ることができるかどうかを示します。
    5.1 の時点で exists() セマンティクスを厳密に暗示しているため、存在する一般的なリソース記述子の場合は true になります。実際のコンテンツの読み取りは、試行されても失敗する場合があります。ただし、false の値は、リソースコンテンツを読み取ることができないことを明確に示しています。
    関連事項:
    InputStreamSource.getInputStream(), exists()
  - isOpen
```
default boolean isOpen()
```
    このリソースがオープンストリームのハンドルを表すかどうかを示します。true の場合、InputStream を複数回読み取ることはできません。リソースリークを防ぐために、読み取り、閉じなければなりません。
    典型的なリソース記述子の場合、false になります。
  - isFile
```
default boolean isFile()
```
    このリソースがファイルシステム内のファイルを表すかどうかを判断します。true の値は、getFile() 呼び出しが成功することを強く提案しています（ただし保証はしません）。
    これは、デフォルトでは控えめに false です。
    導入:
    5.0
    関連事項:
    getFile()
  - getURL
```
URLSE getURL()
    throws IOExceptionSE
```
    このリソースの URL ハンドルを返します。
    例外:
    IOExceptionSE - リソースを URL として解決できない場合、つまりリソースが記述子として利用できない場合
  - getURI
```
URISE getURI()
    throws IOExceptionSE
```
    このリソースの URI ハンドルを返します。
    例外:
    IOExceptionSE - リソースが URI として解決できない場合、つまりリソースが記述子として利用できない場合
    導入:
    2.5
  - getFile
```
FileSE getFile()
      throws IOExceptionSE
```
    このリソースのファイルハンドルを返します。
    例外:
    FileNotFoundExceptionSE - リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合
    IOExceptionSE - 一般的な解決 / 読み取りエラーの場合
    関連事項:
    InputStreamSource.getInputStream()
  - readableChannel
```
default ReadableByteChannelSE readableChannel()
                                     throws IOExceptionSE
```
    ReadableByteChannelSE を返します。
    各呼び出しで新しいチャネルが作成されることが予想されます。
    デフォルトの実装では、Channels.newChannel(InputStream)SE と InputStreamSource.getInputStream() の結果が返されます。
    戻り値:
    基になるリソースのバイトチャネル (null であってはなりません)
    例外:
    FileNotFoundExceptionSE - 基になるリソースが存在しない場合
    IOExceptionSE - コンテンツチャネルを開けなかった場合
    導入:
    5.0
    関連事項:
    InputStreamSource.getInputStream()
  - contentLength
```
long contentLength()
            throws IOExceptionSE
```
    このリソースのコンテンツの長さを決定します。
    例外:
    IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)
  - lastModified
```
long lastModified()
           throws IOExceptionSE
```
    このリソースの最終変更タイムスタンプを決定します。
    例外:
    IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)
  - createRelative
```
Resource createRelative(StringSE relativePath)
                 throws IOExceptionSE
```
    このリソースに関連するリソースを作成します。
    パラメーター:
    relativePath - 相対パス (このリソースに関連して)
    戻り値:
    相対リソースのリソースハンドル
    例外:
    IOExceptionSE - 相対リソースを決定できない場合
  - getFilename
```
@Nullable
StringSE getFilename()
```
    このリソースのファイル名を決定します。つまり、通常はパスの最後の部分（"myfile.txt" など）を決定します。
    この型のリソースにファイル名がない場合は、null を返します。
  - getDescription
```
StringSE getDescription()
```
    このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。
    実装では、toString メソッドからこの値を返すことも推奨されます。
    関連事項:
    Object.toString()SE

インターフェース Resource

メソッドのサマリー

インターフェース org.springframework.core.io.InputStreamSource から継承されたメソッド

メソッドの詳細

exists

isReadable

isOpen

isFile

getURL

getURI

getFile

readableChannel

contentLength

lastModified

createRelative

getFilename

getDescription