クラス 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この実装は、説明文字列を比較します。booleanexists()この実装は、ファイルを開くことができるかどうかをチェックし、InputStream を開くことができるかどうかにフォールバックします。このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。getFile()この実装は、リソースを絶対ファイルパスに解決できないと想定して、FileNotFoundException をスローします。この実装は、このリソース型にファイル名がないと仮定して、常にnullを返します。基礎となるリソースのコンテンツのInputStreamSE を返します。getURI()この実装は、AbstractResource.getURL()によって返された URL に基づいて URI を構築します。getURL()この実装は、リソースを URL に解決できないと想定して、FileNotFoundException をスローします。inthashCode()この実装は、説明のハッシュコードを返します。booleanこの実装は、exists(5.1 の時点で改訂された)というリソースに対して、常にtrueを返します。longこの実装は、使用可能な場合、元となるファイルのタイムスタンプをチェックします。クラス AbstractResource から継承されたメソッド
getFileForLastModifiedCheck, isFile, isOpen, readableChannel, toStringインターフェース Resource から継承されたメソッド
getContentAsByteArray, getContentAsString, getFilePath
コンストラクターの詳細
VfsResource
指定されたリソースハンドルをラップする新しいVfsResourceを作成します。- パラメーター:
resource-org.jboss.vfs.VirtualFileインスタンス (VFS API への静的な依存関係を回避するために型なし)
メソッドの詳細
getInputStream
インターフェースからコピーされた説明:InputStreamSource基礎となるリソースのコンテンツのInputStreamSE を返します。通常、このような呼び出しごとに新しいストリームが作成されると考えられます。
この要件は、JavaMail などの API を考慮する場合に特に重要です。JavaMail では、メールの添付ファイルを作成するときにストリームを複数回読み取ることができる必要があります。このようなユースケースでは、各
getInputStream()コールが新しいストリームを返す必要があります。- 戻り値:
- 基になるリソースの入力ストリーム (
nullであってはなりません) - 例外:
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 - 例外:
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
equals
hashCode
public int hashCode()クラスからコピーされた説明:AbstractResourceこの実装は、説明のハッシュコードを返します。- オーバーライド:
- クラス
AbstractResourceのhashCode - 関連事項: