クラス FileSystemResource
- 実装されたすべてのインターフェース:
InputStreamSource
、Resource
、WritableResource
java.io.File
および java.nio.file.Path
の Resource
実装は、ファイルシステムターゲットで処理します。File
および URL
としての解決をサポートします。拡張 WritableResource
インターフェースを実装します。 メモ: この Resource
実装は、読み取り / 書き込みのやり取りに NIO.2 API を使用し、Path
SE ハンドルを使用して構築できます。その場合、すべてのファイルシステムやり取りは NIO.2 経由で実行され、getFile()
では File
SE のみが使用されます。
- 導入:
- 28.12.2003
- 作成者:
- Juergen Hoeller, Sam Brannen
- 関連事項:
コンストラクターのサマリー
コンストラクターコンストラクター説明FileSystemResource
(FileSE file) File
SE ハンドルから新しいFileSystemResource
を作成します。FileSystemResource
(StringSE path) ファイルパスから新しいFileSystemResource
を作成します。FileSystemResource
(FileSystemSE fileSystem, StringSE path) FileSystem
SE ハンドルから新しいFileSystemResource
を作成し、指定されたパスを見つけます。FileSystemResource
(PathSE filePath) 方法の概要
修飾子と型メソッド説明long
この実装は、基になるファイル / パスの長さを返します。createRelative
(StringSE relativePath) この実装は FileSystemResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。boolean
この実装は、基になるファイルパスを比較します。boolean
exists()
この実装は、元となるファイルが存在するかどうかを返します。byte[]
このリソースの内容をバイト配列として返します。getContentAsString
(CharsetSE charset) 指定された文字セットを使用して、このリソースの内容を文字列として返します。この実装は、ファイルの絶対パスを含む説明を返します。getFile()
この実装は、元となるファイル参照を返します。この実装は、ファイルの名前を返します。この実装は、基になるファイルの NIO ファイルストリームを開きます。この実装は、基になるファイルの FileOutputStream を開きます。final StringSE
getPath()
このリソースのファイルパスを返します。getURI()
この実装は、元となるファイルの URI を返します。getURL()
この実装は、元となるファイルの URL を返します。int
hashCode()
この実装は、基になるファイルパスのハッシュコードを返します。boolean
isFile()
この実装は常にファイルを示します。boolean
この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します(ディレクトリではなく、コンテンツを含む実際のファイルに対応します)。boolean
この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します(また、ディレクトリではなくコンテンツを含む実際のファイルに対応します)。long
この実装は、基になるファイル / パスの最終変更時刻を返します。この実装は、基になるファイルの FileChannel を開きます。この実装は、基になるファイルの FileChannel を開きます。クラス org.springframework.core.io.AbstractResource から継承されたメソッド
getFileForLastModifiedCheck, isOpen, toString
コンストラクターの詳細
FileSystemResource
ファイルパスから新しいFileSystemResource
を作成します。メモ:
createRelative(java.lang.String)
を介して相対リソースを構築する場合、ここで指定されたリソースベースパスがスラッシュで終わるかどうかが異なります。"C:/dir1/"" の場合、相対パスはそのルートに作成されます: たとえば、相対パス "dir2" → "C:/dir1/dir2""。"C:/dir1"" の場合、相対パスは同じディレクトリレベルに適用されます。: 相対パス "dir2"→ 「C:/dir2"。- パラメーター:
path
- ファイルパス- 関連事項:
FileSystemResource
File
SE ハンドルから新しいFileSystemResource
を作成します。メモ:
createRelative(java.lang.String)
を介して相対リソースを構築する場合、相対パスは同じディレクトリレベルで適用されます : たとえば、new File("C:/dir1"), relative path "dir2" → "C:/dir2"! 指定されたルートディレクトリに相対パスを構築したい場合は、constructor with a file path
を使用してルートパスの末尾にスラッシュを追加します。: 「C:/dir1/"。これは、このディレクトリをすべての相対パスのルートとして示します。- パラメーター:
file
- ファイルハンドル- 関連事項:
FileSystemResource
Path
SE ハンドルから新しいFileSystemResource
を作成し、File
SE ではなく NIO.2 を介してすべてのファイルシステムの対話を実行します。PathResource
とは対照的に、このバリアントは、特にパスのクリーニングとcreateRelative(String)
の処理に関して、一般的なFileSystemResource
の規則に厳密に従います。メモ:
createRelative(java.lang.String)
を介して相対リソースを構築する場合、相対パスは同じディレクトリレベルで適用されます : たとえば、Paths.get("C:/dir1"), 相対パス "dir2" → "C:/dir2"! 指定されたルートディレクトリに相対パスを構築したい場合は、constructor with a file path
を使用してルートパスの末尾にスラッシュを追加します。: 「C:/dir1/"。これは、このディレクトリをすべての相対パスのルートとして示します。または、createRelative
のjava.nio.path.Path
解決にPathResource(Path)
を使用し、常に相対パスをネストすることを検討してください。- パラメーター:
filePath
- ファイルへのパスハンドル- 導入:
- 5.1
- 関連事項:
FileSystemResource
FileSystem
SE ハンドルから新しいFileSystemResource
を作成し、指定されたパスを見つけます。これは
FileSystemResource(String)
の代替であり、File
SE ではなく NIO.2 を介してすべてのファイルシステムの対話を実行します。- パラメーター:
fileSystem
- FileSystem 内でパスを見つけるpath
- ファイルパス- 導入:
- 5.1.1
- 関連事項:
メソッドの詳細
getPath
このリソースのファイルパスを返します。exists
public boolean exists()この実装は、元となるファイルが存在するかどうかを返します。- 次で指定:
- インターフェース
Resource
のexists
- オーバーライド:
- クラス
AbstractResource
のexists
- 関連事項:
isReadable
public boolean isReadable()この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します(ディレクトリではなく、コンテンツを含む実際のファイルに対応します)。- 次で指定:
- インターフェース
Resource
のisReadable
- オーバーライド:
- クラス
AbstractResource
のisReadable
- 関連事項:
getInputStream
この実装は、基になるファイルの NIO ファイルストリームを開きます。- 次で指定:
- インターフェース
InputStreamSource
のgetInputStream
- 戻り値:
- 基になるリソースの入力ストリーム (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基盤となるリソースが存在しない場合IOExceptionSE
- コンテンツストリームを開けなかった場合- 関連事項:
getContentAsByteArray
インターフェースからコピーされた説明:Resource
このリソースの内容をバイト配列として返します。- 次で指定:
- インターフェース
Resource
のgetContentAsByteArray
- 戻り値:
- バイト配列としてのこのリソースの内容
- 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合
getContentAsString
インターフェースからコピーされた説明:Resource
指定された文字セットを使用して、このリソースの内容を文字列として返します。- 次で指定:
- インターフェース
Resource
のgetContentAsString
- パラメーター:
charset
- デコードに使用する文字セット- 戻り値:
- このリソースの内容を
String
として - 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合
isWritable
public boolean isWritable()この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します(また、ディレクトリではなくコンテンツを含む実際のファイルに対応します)。getOutputStream
この実装は、基になるファイルの FileOutputStream を開きます。- 次で指定:
- インターフェース
WritableResource
のgetOutputStream
- 例外:
IOExceptionSE
- ストリームを開けなかった場合- 関連事項:
getURL
この実装は、元となるファイルの URL を返します。- 次で指定:
- インターフェース
Resource
のgetURL
- オーバーライド:
- クラス
AbstractResource
のgetURL
- 例外:
IOExceptionSE
- リソースを URL として解決できない場合、つまりリソースが記述子として使用できない場合- 関連事項:
getURI
この実装は、元となるファイルの URI を返します。- 次で指定:
- インターフェース
Resource
のgetURI
- オーバーライド:
- クラス
AbstractResource
のgetURI
- 例外:
IOExceptionSE
- リソースを URI として解決できない場合、つまりリソースが記述子として使用できない場合- 関連事項:
isFile
public boolean isFile()この実装は常にファイルを示します。- 次で指定:
- インターフェース
Resource
のisFile
- オーバーライド:
- クラス
AbstractResource
のisFile
- 関連事項:
getFile
この実装は、元となるファイル参照を返します。- 次で指定:
- インターフェース
Resource
のgetFile
- オーバーライド:
- クラス
AbstractResource
のgetFile
- 関連事項:
readableChannel
この実装は、基になるファイルの FileChannel を開きます。- 次で指定:
- インターフェース
Resource
のreadableChannel
- オーバーライド:
- クラス
AbstractResource
のreadableChannel
- 戻り値:
- 基になるリソースのバイトチャネル (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基になるリソースが存在しない場合IOExceptionSE
- コンテンツチャネルを開けなかった場合- 関連事項:
writableChannel
この実装は、基になるファイルの FileChannel を開きます。- 次で指定:
- インターフェース
WritableResource
のwritableChannel
- 戻り値:
- 基になるリソースのバイトチャネル (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基になるリソースが存在しない場合IOExceptionSE
- コンテンツチャネルを開けなかった場合- 関連事項:
contentLength
この実装は、基になるファイル / パスの長さを返します。- 次で指定:
- インターフェース
Resource
のcontentLength
- オーバーライド:
- クラス
AbstractResource
のcontentLength
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
lastModified
この実装は、基になるファイル / パスの最終変更時刻を返します。- 次で指定:
- インターフェース
Resource
のlastModified
- オーバーライド:
- クラス
AbstractResource
のlastModified
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
createRelative
この実装は FileSystemResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。- 次で指定:
- インターフェース
Resource
のcreateRelative
- オーバーライド:
- クラス
AbstractResource
のcreateRelative
- パラメーター:
relativePath
- 相対パス (このリソースに関連して)- 戻り値:
- 相対リソースのリソースハンドル
- 関連事項:
getFilename
この実装は、ファイルの名前を返します。- 次で指定:
- インターフェース
Resource
のgetFilename
- オーバーライド:
- クラス
AbstractResource
のgetFilename
- 関連事項:
getDescription
この実装は、ファイルの絶対パスを含む説明を返します。- 次で指定:
- インターフェース
Resource
のgetDescription
- 関連事項:
equals
この実装は、基になるファイルパスを比較します。- オーバーライド:
- クラス
AbstractResource
のequals
- 関連事項:
hashCode
public int hashCode()この実装は、基になるファイルパスのハッシュコードを返します。- オーバーライド:
- クラス
AbstractResource
のhashCode
- 関連事項: