クラス PathResource
java.lang.ObjectSE
org.springframework.core.io.AbstractResource
org.springframework.core.io.PathResource
- 実装されたすべてのインターフェース:
InputStreamSource
、Resource
、WritableResource
Path
SE ハンドルの Resource
実装。Path
API を介してすべての操作と変換を実行します。File
SE および URL
SE としての解決をサポートします。拡張 WritableResource
インターフェースを実装します。 メモ: 5.1 以降、Path
SE サポートは FileSystemResource
でも利用でき、Spring の標準の文字列ベースのパス変換を適用しますが、Files
SE API を介してすべての操作を実行します。この PathResource
は事実上、createRelative
の動作が異なる純粋な java.nio.path.Path
ベースの代替です。
- 導入:
- 4.0
- 作成者:
- Philippe Marschall, Juergen Hoeller
- 関連事項:
コンストラクターのサマリー
コンストラクターコンストラクター説明PathResource
(StringSE path) パス文字列から新しいPathResource
を作成します。PathResource
(URISE uri) URI
SE から新しいPathResource
を作成します。PathResource
(PathSE path) Path
SE ハンドルから新しいPathResource
を作成します。方法の概要
修飾子と型メソッド説明long
この実装は、元となるファイルの長さを返します。createRelative
(StringSE relativePath) この実装では、このリソース記述子の元となるファイルのパスに相対的な指定されたパスを適用して、PathResource
を作成します。boolean
この実装では、基礎となるPath
SE 参照を比較します。boolean
exists()
この実装は、元となるファイルが存在するかどうかを返します。byte[]
このリソースの内容をバイト配列として返します。getContentAsString
(CharsetSE charset) 指定された文字セットを使用して、このリソースの内容を文字列として返します。このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。getFile()
この実装は、基礎となるFile
SE 参照を返します。この実装は、ファイルの名前を返します。この実装では、基になるファイルのInputStream
SE を開きます。この実装では、基になるファイルのOutputStream
SE を開きます。final StringSE
getPath()
このリソースのファイルパスを返します。getURI()
この実装は、基になるファイルのURI
SE を返します。getURL()
この実装は、基になるファイルのURL
SE を返します。int
hashCode()
この実装は、基礎となるPath
SE 参照のハッシュコードを返します。boolean
isFile()
この実装は常にファイルを示します。boolean
この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します(ディレクトリではなく、コンテンツを含む実際のファイルに対応します)。boolean
この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します(また、ディレクトリではなくコンテンツを含む実際のファイルに対応します)。long
この実装は、基になるファイルのタイムスタンプを返します。この実装では、基になるファイルのReadableByteChannel
SE を開きます。この実装では、基になるファイルのWritableByteChannel
SE を開きます。クラス org.springframework.core.io.AbstractResource から継承されたメソッド
getFileForLastModifiedCheck, isOpen, toString
コンストラクターの詳細
PathResource
Path
SE ハンドルから新しいPathResource
を作成します。メモ:
FileSystemResource
とは異なり、createRelative(java.lang.String)
を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば、Paths.get("C:/dir1/")、相対パス "dir2" → "C:/dir1/dir2"!- パラメーター:
path
- パスハンドル
PathResource
パス文字列から新しいPathResource
を作成します。メモ:
FileSystemResource
とは異なり、createRelative(java.lang.String)
を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば、Paths.get("C:/dir1/")、相対パス "dir2" → "C:/dir1/dir2"!- パラメーター:
path
- 通り- 関連事項:
PathResource
URI
SE から新しいPathResource
を作成します。メモ:
FileSystemResource
とは異なり、createRelative(java.lang.String)
を介して相対リソースを構築する場合、相対パスは指定されたルートの下に構築されます : たとえば、Paths.get("C:/dir1/")、相対パス "dir2" → "C:/dir1/dir2"!- パラメーター:
uri
- パス URI- 関連事項:
メソッドの詳細
getPath
このリソースのファイルパスを返します。exists
public boolean exists()この実装は、元となるファイルが存在するかどうかを返します。- 次で指定:
- インターフェース
Resource
のexists
- オーバーライド:
- クラス
AbstractResource
のexists
- 関連事項:
isReadable
public boolean isReadable()この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します(ディレクトリではなく、コンテンツを含む実際のファイルに対応します)。- 次で指定:
- インターフェース
Resource
のisReadable
- オーバーライド:
- クラス
AbstractResource
のisReadable
- 関連事項:
getInputStream
この実装では、基になるファイルのInputStream
SE を開きます。- 次で指定:
- インターフェース
InputStreamSource
のgetInputStream
- 戻り値:
- 基になるリソースの入力ストリーム (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基盤となるリソースが存在しない場合IOExceptionSE
- コンテンツストリームを開けなかった場合- 関連事項:
getContentAsByteArray
インターフェースからコピーされた説明:Resource
このリソースの内容をバイト配列として返します。- 次で指定:
- インターフェース
Resource
のgetContentAsByteArray
- 戻り値:
- バイト配列としてのこのリソースの内容
- 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合
getContentAsString
インターフェースからコピーされた説明:Resource
指定された文字セットを使用して、このリソースの内容を文字列として返します。- 次で指定:
- インターフェース
Resource
のgetContentAsString
- パラメーター:
charset
- デコードに使用する文字セット- 戻り値:
- このリソースの内容を
String
として - 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合
isWritable
public boolean isWritable()この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します(また、ディレクトリではなくコンテンツを含む実際のファイルに対応します)。getOutputStream
この実装では、基になるファイルのOutputStream
SE を開きます。- 次で指定:
- インターフェース
WritableResource
のgetOutputStream
- 例外:
IOExceptionSE
- ストリームを開けなかった場合- 関連事項:
getURL
この実装は、基になるファイルのURL
SE を返します。- 次で指定:
- インターフェース
Resource
のgetURL
- オーバーライド:
- クラス
AbstractResource
のgetURL
- 例外:
IOExceptionSE
- リソースを URL として解決できない場合、つまりリソースが記述子として使用できない場合- 関連事項:
getURI
この実装は、基になるファイルのURI
SE を返します。- 次で指定:
- インターフェース
Resource
のgetURI
- オーバーライド:
- クラス
AbstractResource
のgetURI
- 例外:
IOExceptionSE
- リソースを URI として解決できない場合、つまりリソースが記述子として使用できない場合- 関連事項:
isFile
public boolean isFile()この実装は常にファイルを示します。- 次で指定:
- インターフェース
Resource
のisFile
- オーバーライド:
- クラス
AbstractResource
のisFile
- 関連事項:
getFile
この実装は、基礎となるFile
SE 参照を返します。- 次で指定:
- インターフェース
Resource
のgetFile
- オーバーライド:
- クラス
AbstractResource
のgetFile
- 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合- 関連事項:
readableChannel
この実装では、基になるファイルのReadableByteChannel
SE を開きます。- 次で指定:
- インターフェース
Resource
のreadableChannel
- オーバーライド:
- クラス
AbstractResource
のreadableChannel
- 戻り値:
- 基になるリソースのバイトチャネル (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基になるリソースが存在しない場合IOExceptionSE
- コンテンツチャネルを開けなかった場合- 関連事項:
writableChannel
この実装では、基になるファイルのWritableByteChannel
SE を開きます。- 次で指定:
- インターフェース
WritableResource
のwritableChannel
- 戻り値:
- 基になるリソースのバイトチャネル (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基になるリソースが存在しない場合IOExceptionSE
- コンテンツチャネルを開けなかった場合- 関連事項:
contentLength
この実装は、元となるファイルの長さを返します。- 次で指定:
- インターフェース
Resource
のcontentLength
- オーバーライド:
- クラス
AbstractResource
のcontentLength
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
lastModified
この実装は、基になるファイルのタイムスタンプを返します。- 次で指定:
- インターフェース
Resource
のlastModified
- オーバーライド:
- クラス
AbstractResource
のlastModified
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
createRelative
この実装では、このリソース記述子の元となるファイルのパスに相対的な指定されたパスを適用して、PathResource
を作成します。- 次で指定:
- インターフェース
Resource
のcreateRelative
- オーバーライド:
- クラス
AbstractResource
のcreateRelative
- パラメーター:
relativePath
- 相対パス (このリソースに関連して)- 戻り値:
- 相対リソースのリソースハンドル
- 関連事項:
getFilename
この実装は、ファイルの名前を返します。- 次で指定:
- インターフェース
Resource
のgetFilename
- オーバーライド:
- クラス
AbstractResource
のgetFilename
- 関連事項:
getDescription
インターフェースからコピーされた説明:Resource
このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。実装では、
toString
メソッドからこの値を返すことも推奨されます。- 次で指定:
- インターフェース
Resource
のgetDescription
- 関連事項:
equals
この実装では、基礎となるPath
SE 参照を比較します。- オーバーライド:
- クラス
AbstractResource
のequals
- 関連事項:
hashCode
public int hashCode()この実装は、基礎となるPath
SE 参照のハッシュコードを返します。- オーバーライド:
- クラス
AbstractResource
のhashCode
- 関連事項: