クラス AbstractResource
java.lang.ObjectSE
org.springframework.core.io.AbstractResource
- 実装されたすべてのインターフェース:
InputStreamSource
,Resource
- 既知の直属サブクラス
AbstractFileResolvingResource
、ByteArrayResource
、DescriptiveResource
、FileSystemResource
、InputStreamResource
、ModuleResource
、PathResource
、VfsResource
Resource
実装の便利な基本クラスで、典型的な動作を事前実装します。"exists" メソッドは、ファイルまたは InputStream を開くことができるかどうかを確認します。"isOpen" は常に false を返します。"getURL" と "getFile" は例外をスローします。"toString" は説明を返します。
- 導入:
- 28.12.2003
- 作成者:
- Juergen Hoeller, Sam Brannen
コンストラクターのサマリー
コンストラクター方法の概要
修飾子と型メソッド説明long
このメソッドは、InputStream 全体を読み取ってコンテンツの長さを決定します。createRelative
(StringSE relativePath) この実装は、このリソースに対して相対リソースを作成できないと想定して、FileNotFoundException をスローします。boolean
この実装は、説明文字列を比較します。boolean
exists()
この実装は、ファイルを開くことができるかどうかをチェックし、InputStream を開くことができるかどうかにフォールバックします。getFile()
この実装は、リソースを絶対ファイルパスに解決できないと想定して、FileNotFoundException をスローします。protected FileSE
タイムスタンプチェックに使用するファイルを決定します。この実装は、このリソース型にファイル名がないと仮定して、常にnull
を返します。getURI()
この実装は、getURL()
によって返された URL に基づいて URI を構築します。getURL()
この実装は、リソースを URL に解決できないと想定して、FileNotFoundException をスローします。int
hashCode()
この実装は、説明のハッシュコードを返します。boolean
isFile()
この実装は、常にfalse
を返します。boolean
isOpen()
この実装は、常にfalse
を返します。boolean
この実装は、exists
(5.1 の時点で改訂された)というリソースに対して、常にtrue
を返します。long
この実装は、使用可能な場合、元となるファイルのタイムスタンプをチェックします。この実装は、InputStreamSource.getInputStream()
の結果とともにChannels.newChannel(InputStream)
SE を返します。toString()
この実装は、このリソースの説明を返します。クラス java.lang.ObjectSE から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.core.io.InputStreamSource から継承されたメソッド
getInputStream
インターフェース org.springframework.core.io.Resource から継承されたメソッド
getContentAsByteArray, getContentAsString, getDescription
コンストラクターの詳細
AbstractResource
public AbstractResource()
メソッドの詳細
exists
public boolean exists()この実装は、ファイルを開くことができるかどうかをチェックし、InputStream を開くことができるかどうかにフォールバックします。これは、ディレクトリとコンテンツリソースの両方をカバーします。
isReadable
public boolean isReadable()この実装は、exists
(5.1 の時点で改訂された)というリソースに対して、常にtrue
を返します。- 次で指定:
- インターフェース
Resource
のisReadable
- 関連事項:
isOpen
public boolean isOpen()この実装は、常にfalse
を返します。isFile
public boolean isFile()この実装は、常にfalse
を返します。getURL
この実装は、リソースを URL に解決できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のgetURL
- 例外:
IOExceptionSE
- リソースを URL として解決できない場合、つまりリソースが記述子として使用できない場合
getURI
この実装は、getURL()
によって返された URL に基づいて URI を構築します。- 次で指定:
- インターフェース
Resource
のgetURI
- 例外:
IOExceptionSE
- リソースを URI として解決できない場合、つまりリソースが記述子として使用できない場合
getFile
この実装は、リソースを絶対ファイルパスに解決できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のgetFile
- 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合- 関連事項:
readableChannel
この実装は、InputStreamSource.getInputStream()
の結果とともにChannels.newChannel(InputStream)
SE を返します。これは
Resource
の対応するデフォルトのメソッドと同じですが、クラス階層での効率的な JVM レベルのディスパッチのためにここでミラーリングされます。- 次で指定:
- インターフェース
Resource
のreadableChannel
- 戻り値:
- 基になるリソースのバイトチャネル (
null
であってはなりません) - 例外:
FileNotFoundExceptionSE
- 基になるリソースが存在しない場合IOExceptionSE
- コンテンツチャネルを開けなかった場合- 関連事項:
contentLength
このメソッドは、InputStream 全体を読み取ってコンテンツの長さを決定します。InputStreamResource
のカスタムサブクラスの場合、このメソッドをより最適な実装でオーバーライドすることを強くお勧めします。たとえば、ファイルの長さをチェックしたり、ストリームを一度しか読み取れない場合は単に -1 を返したりします。- 次で指定:
- インターフェース
Resource
のcontentLength
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
lastModified
この実装は、使用可能な場合、元となるファイルのタイムスタンプをチェックします。- 次で指定:
- インターフェース
Resource
のlastModified
- 例外:
IOExceptionSE
- リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)- 関連事項:
getFileForLastModifiedCheck
タイムスタンプチェックに使用するファイルを決定します。デフォルトの実装は
getFile()
に委譲します。- 戻り値:
- タイムスタンプのチェックに使用するファイル (非
null
) - 例外:
FileNotFoundExceptionSE
- リソースが絶対ファイルパスとして解決できない場合、つまりファイルシステムで使用できない場合IOExceptionSE
- 一般的な解決 / 読み取りエラーの場合
createRelative
この実装は、このリソースに対して相対リソースを作成できないと想定して、FileNotFoundException をスローします。- 次で指定:
- インターフェース
Resource
のcreateRelative
- パラメーター:
relativePath
- 相対パス (このリソースに関連して)- 戻り値:
- 相対リソースのリソースハンドル
- 例外:
IOExceptionSE
- 相対リソースを決定できない場合
getFilename
この実装は、このリソース型にファイル名がないと仮定して、常にnull
を返します。- 次で指定:
- インターフェース
Resource
のgetFilename
equals
この実装は、説明文字列を比較します。hashCode
public int hashCode()この実装は、説明のハッシュコードを返します。toString
この実装は、このリソースの説明を返します。