クラス VfsResource
java.lang.ObjectSE
org.springframework.core.io.AbstractResource
org.springframework.core.io.VfsResource
- 実装されたすべてのインターフェース:
InputStreamSource
,Resource
JBoss VFS ベースの
Resource
実装。Spring 4.0 の時点で、このクラスは JBoss AS 6+(パッケージ org.jboss.vfs
)で VFS 3.x をサポートし、特に JBoss AS7 および WildFly 8+ と互換性があります。
- 導入:
- 3.0
- 作成者:
- Ales Justin, Juergen Hoeller, Costin Leau, Sam Brannen
コンストラクターのサマリー
コンストラクター方法の概要
修飾子と型メソッド説明long
このメソッドは、InputStream 全体を読み取ってコンテンツの長さを決定します。createRelative
(StringSE relativePath) この実装は、このリソースに対して相対リソースを作成できないと想定して、FileNotFoundException をスローします。boolean
この実装は、説明文字列を比較します。boolean
exists()
この実装は、ファイルを開くことができるかどうかをチェックし、InputStream を開くことができるかどうかにフォールバックします。このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。getFile()
この実装は、リソースを絶対ファイルパスに解決できないと想定して、FileNotFoundException をスローします。この実装は、このリソース型にファイル名がないと仮定して、常にnull
を返します。基礎となるリソースのコンテンツのInputStream
SE を返します。getURI()
この実装は、AbstractResource.getURL()
によって返された URL に基づいて URI を構築します。getURL()
この実装は、リソースを URL に解決できないと想定して、FileNotFoundException をスローします。int
hashCode()
この実装は、説明のハッシュコードを返します。boolean
この実装は、exists
(5.1 の時点で改訂された)というリソースに対して、常にtrue
を返します。long
この実装は、使用可能な場合、元となるファイルのタイムスタンプをチェックします。クラス org.springframework.core.io.AbstractResource から継承されたメソッド
getFileForLastModifiedCheck, isFile, isOpen, readableChannel, toString
クラス java.lang.ObjectSE から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.core.io.Resource から継承されたメソッド
getContentAsByteArray, getContentAsString
コンストラクターの詳細
VfsResource
指定されたリソースハンドルをラップする新しいVfsResource
を作成します。- パラメーター:
resource
-org.jboss.vfs.VirtualFile
インスタンス (VFS API への静的な依存関係を回避するために型なし)
メソッドの詳細
getInputStream
インターフェースからコピーされた説明:InputStreamSource
基礎となるリソースのコンテンツのInputStream
SE を返します。通常、このような呼び出しごとに新しいストリームが作成されると考えられます。
この要件は、JavaMail などの API を考慮する場合に特に重要です。JavaMail では、メールの添付ファイルを作成するときにストリームを複数回読み取ることができる必要があります。このようなユースケースでは、各
getInputStream()
コールが新しいストリームを返す必要があります。- 戻り値:
- 基になるリソースの入力ストリーム (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基盤となるリソースが存在しない場合IOExceptionSE
- コンテンツストリームを開けなかった場合- 関連事項:
exists
public boolean exists()クラスからコピーされた説明:AbstractResource
この実装は、ファイルを開くことができるかどうかをチェックし、InputStream を開くことができるかどうかにフォールバックします。これは、ディレクトリとコンテンツリソースの両方をカバーします。
- 次で指定:
- インターフェース
Resource
のexists
- オーバーライド:
- クラス
AbstractResource
のexists
isReadable
public boolean isReadable()クラスからコピーされた説明:AbstractResource
この実装は、exists
(5.1 の時点で改訂された)というリソースに対して、常にtrue
を返します。- 次で指定:
- インターフェース
Resource
のisReadable
- オーバーライド:
- クラス
AbstractResource
のisReadable
- 関連事項:
getURL
クラスからコピーされた説明:AbstractResource
この実装は、リソースを URL に解決できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のgetURL
- オーバーライド:
- クラス
AbstractResource
のgetURL
- 例外:
IOExceptionSE
- リソースを URL として解決できない場合、つまりリソースが記述子として使用できない場合
getURI
クラスからコピーされた説明:AbstractResource
この実装は、AbstractResource.getURL()
によって返された URL に基づいて URI を構築します。- 次で指定:
- インターフェース
Resource
のgetURI
- オーバーライド:
- クラス
AbstractResource
のgetURI
- 例外:
IOExceptionSE
- リソースを URI として解決できない場合、つまりリソースが記述子として使用できない場合
getFile
クラスからコピーされた説明:AbstractResource
この実装は、リソースを絶対ファイルパスに解決できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のgetFile
- オーバーライド:
- クラス
AbstractResource
のgetFile
- 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合- 関連事項:
contentLength
クラスからコピーされた説明:AbstractResource
このメソッドは、InputStream 全体を読み取ってコンテンツの長さを決定します。InputStreamResource
のカスタムサブクラスの場合、このメソッドをより最適な実装でオーバーライドすることを強くお勧めします。たとえば、ファイルの長さをチェックしたり、ストリームを一度しか読み取れない場合は単に -1 を返したりします。- 次で指定:
- インターフェース
Resource
のcontentLength
- オーバーライド:
- クラス
AbstractResource
のcontentLength
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
lastModified
クラスからコピーされた説明:AbstractResource
この実装は、使用可能な場合、元となるファイルのタイムスタンプをチェックします。- 次で指定:
- インターフェース
Resource
のlastModified
- オーバーライド:
- クラス
AbstractResource
のlastModified
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
createRelative
クラスからコピーされた説明:AbstractResource
この実装は、このリソースに対して相対リソースを作成できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のcreateRelative
- オーバーライド:
- クラス
AbstractResource
のcreateRelative
- パラメーター:
relativePath
- 相対パス (このリソースに関連して)- 戻り値:
- 相対リソースのリソースハンドル
- 例外:
IOExceptionSE
- 相対リソースを決定できない場合
getFilename
クラスからコピーされた説明:AbstractResource
この実装は、このリソース型にファイル名がないと仮定して、常にnull
を返します。- 次で指定:
- インターフェース
Resource
のgetFilename
- オーバーライド:
- クラス
AbstractResource
のgetFilename
getDescription
インターフェースからコピーされた説明:Resource
このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。実装では、
toString
メソッドからこの値を返すことも推奨されます。- 関連事項:
equals
クラスからコピーされた説明:AbstractResource
この実装は、説明文字列を比較します。- オーバーライド:
- クラス
AbstractResource
のequals
- 関連事項:
hashCode
public int hashCode()クラスからコピーされた説明:AbstractResource
この実装は、説明のハッシュコードを返します。- オーバーライド:
- クラス
AbstractResource
のhashCode
- 関連事項: