PathResource (Spring Framework API)

java.lang.ObjectSE
- org.springframework.core.io.AbstractResource
- - org.springframework.core.io.PathResource

実装されたすべてのインターフェース:
InputStreamSource, Resource, WritableResource
```
public class PathResource
extends AbstractResource
implements WritableResource
```
PathSE ハンドルの Resource 実装。Path API を介してすべての操作と変換を実行します。FileSE および URLSE としての解決をサポートします。拡張 WritableResource インターフェースを実装します。
メモ: 5.1 以降、PathSE サポートは FileSystemResource でも利用でき、Spring の標準の文字列ベースのパス変換を適用しますが、FilesSE API を介してすべての操作を実行します。この PathResource は事実上、createRelative の動作が異なる純粋な java.nio.path.Path ベースの代替です。
導入:
4.0
作成者:
Philippe Marschall, Juergen Hoeller
関連事項:
PathSE, FilesSE, FileSystemResource

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`PathResource(PathSE path)` パスハンドルから新しい PathResource を作成します。
`PathResource(StringSE path)` パスハンドルから新しい PathResource を作成します。
`PathResource(URISE uri)` パスハンドルから新しい PathResource を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`long`	`contentLength()` この実装は、元となるファイルの長さを返します。
`Resource`	`createRelative(StringSE relativePath)` この実装は PathResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。
`boolean`	`equals(ObjectSE other)` この実装は、基になるパス参照を比較します。
`boolean`	`exists()` この実装は、元となるファイルが存在するかどうかを返します。
`StringSE`	`getDescription()` このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。
`FileSE`	`getFile()` この実装は、元となるファイル参照を返します。
`StringSE`	`getFilename()` この実装は、ファイルの名前を返します。
`InputStreamSE`	`getInputStream()` この実装は、基になるファイルの InputStream を開きます。
`OutputStreamSE`	`getOutputStream()` この実装は、基になるファイルの OutputStream を開きます。
`StringSE`	`getPath()` このリソースのファイルパスを返します。
`URISE`	`getURI()` この実装は、元となるファイルの URI を返します。
`URLSE`	`getURL()` この実装は、元となるファイルの URL を返します。
`int`	`hashCode()` この実装は、基になる Path 参照のハッシュコードを返します。
`boolean`	`isFile()` この実装は常にファイルを示します。
`boolean`	`isReadable()` この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します（ディレクトリではなく、コンテンツを含む実際のファイルに対応します）。
`boolean`	`isWritable()` この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します（また、ディレクトリではなくコンテンツを含む実際のファイルに対応します）。
`long`	`lastModified()` この実装は、基になるファイルのタイムスタンプを返します。
`ReadableByteChannelSE`	`readableChannel()` この実装は、基になるファイルのチャネルを開きます。
`WritableByteChannelSE`	`writableChannel()` この実装は、基になるファイルのチャネルを開きます。

クラス org.springframework.core.io.AbstractResource から継承されたメソッド
getFileForLastModifiedCheck, isOpen, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, finalizeSE, getClassSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

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

- コンストラクターの詳細
  - PathResource
```
public PathResource(PathSE path)
```
    パスハンドルから新しい PathResource を作成します。
    メモ: FileSystemResource とは異なり、createRelative(java.lang.String) を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば Paths.get（"C:/dir1/"）、相対パス " dir2 "→" C:/dir1/dir2"!
    パラメーター:
    path - パスハンドル
  - PathResource
```
public PathResource(StringSE path)
```
    パスハンドルから新しい PathResource を作成します。
    メモ: FileSystemResource とは異なり、createRelative(java.lang.String) を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば Paths.get（"C:/dir1/"）、相対パス " dir2 "→" C:/dir1/dir2"!
    パラメーター:
    path - 通り
    関連事項:
    Paths.get(String, String...)SE
  - PathResource
```
public PathResource(URISE uri)
```
    パスハンドルから新しい PathResource を作成します。
    メモ: FileSystemResource とは異なり、createRelative(java.lang.String) を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば Paths.get（"C:/dir1/"）、相対パス " dir2 "→" C:/dir1/dir2"!
    パラメーター:
    uri - パス URI
    関連事項:
    Paths.get(URI)SE
- メソッドの詳細
  - getPath
```
public final StringSE getPath()
```
    このリソースのファイルパスを返します。
  - exists
```
public boolean exists()
```
    この実装は、元となるファイルが存在するかどうかを返します。
    次で指定:
    インターフェース Resource の exists
    オーバーライド:
    クラス AbstractResource の exists
    関連事項:
    Files.exists(Path, java.nio.file.LinkOption...)SE
  - isReadable
```
public boolean isReadable()
```
    この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します（ディレクトリではなく、コンテンツを含む実際のファイルに対応します）。
    次で指定:
    インターフェース Resource の isReadable
    オーバーライド:
    クラス AbstractResource の isReadable
    関連事項:
    Files.isReadable(Path)SE, Files.isDirectory(Path, java.nio.file.LinkOption...)SE
  - getInputStream
```
public InputStreamSE getInputStream()
                           throws IOExceptionSE
```
    この実装は、基になるファイルの InputStream を開きます。
    次で指定:
    インターフェース InputStreamSource の getInputStream
    戻り値:
    基になるリソースの入力ストリーム (null であってはなりません)
    例外:
    FileNotFoundExceptionSE - 基盤となるリソースが存在しない場合
    IOExceptionSE - コンテンツストリームを開けなかった場合
    関連事項:
    FileSystemProvider.newInputStream(Path, OpenOption...)SE
  - isWritable
```
public boolean isWritable()
```
    この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します（また、ディレクトリではなくコンテンツを含む実際のファイルに対応します）。
    次で指定:
    インターフェース WritableResource の isWritable
    関連事項:
    Files.isWritable(Path)SE, Files.isDirectory(Path, java.nio.file.LinkOption...)SE
  - getOutputStream
```
public OutputStreamSE getOutputStream()
                             throws IOExceptionSE
```
    この実装は、基になるファイルの OutputStream を開きます。
    次で指定:
    インターフェース WritableResource の getOutputStream
    例外:
    IOExceptionSE - ストリームを開けなかった場合
    関連事項:
    FileSystemProvider.newOutputStream(Path, OpenOption...)SE
  - getURL
```
public URLSE getURL()
           throws IOExceptionSE
```
    この実装は、元となるファイルの URL を返します。
    次で指定:
    インターフェース Resource の getURL
    オーバーライド:
    クラス AbstractResource の getURL
    例外:
    IOExceptionSE - リソースを URL として解決できない場合、つまりリソースが記述子として利用できない場合
    関連事項:
    Path.toUri()SE, URI.toURL()SE
  - getURI
```
public URISE getURI()
           throws IOExceptionSE
```
    この実装は、元となるファイルの URI を返します。
    次で指定:
    インターフェース Resource の getURI
    オーバーライド:
    クラス AbstractResource の getURI
    例外:
    IOExceptionSE - リソースが URI として解決できない場合、つまりリソースが記述子として利用できない場合
    関連事項:
    Path.toUri()SE
  - isFile
```
public boolean isFile()
```
    この実装は常にファイルを示します。
    次で指定:
    インターフェース Resource の isFile
    オーバーライド:
    クラス AbstractResource の isFile
    関連事項:
    Resource.getFile()
  - getFile
```
public FileSE getFile()
             throws IOExceptionSE
```
    この実装は、元となるファイル参照を返します。
    次で指定:
    インターフェース Resource の getFile
    オーバーライド:
    クラス AbstractResource の getFile
    例外:
    FileNotFoundExceptionSE - リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合
    IOExceptionSE - 一般的な解決 / 読み取りエラーの場合
    関連事項:
    InputStreamSource.getInputStream()
  - readableChannel
```
public ReadableByteChannelSE readableChannel()
                                    throws IOExceptionSE
```
    この実装は、基になるファイルのチャネルを開きます。
    次で指定:
    インターフェース Resource の readableChannel
    オーバーライド:
    クラス AbstractResource の readableChannel
    戻り値:
    基になるリソースのバイトチャネル (null であってはなりません)
    例外:
    FileNotFoundExceptionSE - 基になるリソースが存在しない場合
    IOExceptionSE - コンテンツチャネルを開けなかった場合
    関連事項:
    Files.newByteChannel(Path, OpenOption...)SE
  - writableChannel
```
public WritableByteChannelSE writableChannel()
                                    throws IOExceptionSE
```
    この実装は、基になるファイルのチャネルを開きます。
    次で指定:
    インターフェース WritableResource の writableChannel
    戻り値:
    基になるリソースのバイトチャネル (null であってはなりません)
    例外:
    FileNotFoundExceptionSE - 基になるリソースが存在しない場合
    IOExceptionSE - コンテンツチャネルを開けなかった場合
    関連事項:
    Files.newByteChannel(Path, OpenOption...)SE
  - contentLength
```
public long contentLength()
                   throws IOExceptionSE
```
    この実装は、元となるファイルの長さを返します。
    次で指定:
    インターフェース Resource の contentLength
    オーバーライド:
    クラス AbstractResource の contentLength
    例外:
    IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)
    関連事項:
    InputStreamSource.getInputStream()
  - lastModified
```
public long lastModified()
                  throws IOExceptionSE
```
    この実装は、基になるファイルのタイムスタンプを返します。
    次で指定:
    インターフェース Resource の lastModified
    オーバーライド:
    クラス AbstractResource の lastModified
    例外:
    IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)
    関連事項:
    Files.getLastModifiedTime(Path, java.nio.file.LinkOption...)SE
  - createRelative
```
public Resource createRelative(StringSE relativePath)
```
    この実装は PathResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。
    次で指定:
    インターフェース Resource の createRelative
    オーバーライド:
    クラス AbstractResource の createRelative
    パラメーター:
    relativePath - 相対パス (このリソースに関連して)
    戻り値:
    相対リソースのリソースハンドル
    関連事項:
    Path.resolve(String)SE
  - getFilename
```
public StringSE getFilename()
```
    この実装は、ファイルの名前を返します。
    次で指定:
    インターフェース Resource の getFilename
    オーバーライド:
    クラス AbstractResource の getFilename
    関連事項:
    Path.getFileName()SE
  - getDescription
```
public StringSE getDescription()
```
    インターフェースからコピーされた説明: Resource
    このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。
    実装では、toString メソッドからこの値を返すことも推奨されます。
    次で指定:
    インターフェース Resource の getDescription
    関連事項:
    Object.toString()SE
  - equals
```
public boolean equals(@Nullable
                      ObjectSE other)
```
    この実装は、基になるパス参照を比較します。
    オーバーライド:
    クラス AbstractResource の equals
    関連事項:
    Resource.getDescription()
  - hashCode
```
public int hashCode()
```
    この実装は、基になる Path 参照のハッシュコードを返します。
    オーバーライド:
    クラス AbstractResource の hashCode
    関連事項:
    Resource.getDescription()

クラス PathResource

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.core.io.AbstractResource から継承されたメソッド

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

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

コンストラクターの詳細

PathResource

PathResource

PathResource

メソッドの詳細

getPath

exists

isReadable

getInputStream

isWritable

getOutputStream

getURL

getURI

isFile

getFile

readableChannel

writableChannel

contentLength

lastModified

createRelative

getFilename

getDescription

equals

hashCode