ServletContextResource (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.core.io.AbstractResource
- - org.springframework.core.io.AbstractFileResolvingResource
  - - org.springframework.web.context.support.ServletContextResource

実装されているすべてのインターフェース:
ContextResource, InputStreamSource, Resource
```
public class ServletContextResource
extends AbstractFileResolvingResource
implements ContextResource
```
ServletContextEE リソースの Resource 実装。Web アプリケーションのルートディレクトリ内の相対パスを解釈します。
常にストリームアクセスと URL アクセスをサポートしますが、Web アプリケーションアーカイブが展開されている場合にのみ java.io.File アクセスを許可します。
導入:
28.12.2003
作成者:
Juergen Hoeller
関連事項:
ServletContext.getResourceAsStream(java.lang.String)EE, ServletContext.getResource(java.lang.String)EE, ServletContext.getRealPath(java.lang.String)EE

コンストラクターの概要
コンストラクター
コンストラクターと説明
ServletContextResource(ServletContextEE servletContext, StringSE path)
新しい ServletContextResource を作成します。

コンストラクター
コンストラクターと説明
`ServletContextResource(ServletContextEE servletContext, StringSE path)` 新しい ServletContextResource を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`Resource`	`createRelative(StringSE relativePath)` この実装は ServletContextResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。
`boolean`	`equals(ObjectSE obj)` この実装は、基になる ServletContext リソースの場所を比較します。
`boolean`	`exists()` この実装は `ServletContext.getResource` をチェックします。
`StringSE`	`getDescription()` この実装は、ServletContext リソースの場所を含む説明を返します。
`FileSE`	`getFile()` この実装は "file:" URL を解決するか、代わりに `ServletContext.getRealPath` に委譲し、見つからないか解決できない場合は FileNotFoundException をスローします。
`StringSE`	`getFilename()` この実装は、この ServletContext リソースが参照するファイルの名前を返します。
`InputStreamSE`	`getInputStream()` この実装は `ServletContext.getResourceAsStream` に委譲しますが、リソースが見つからない場合は FileNotFoundException をスローします。
`StringSE`	`getPath()` このリソースのパスを返します。
`StringSE`	`getPathWithinContext()` 囲んでいる「コンテキスト」内のパスを返します。
`ServletContextEE`	`getServletContext()` このリソースの ServletContext を返します。
`URLSE`	`getURL()` この実装は `ServletContext.getResource` に委譲しますが、リソースが見つからない場合は FileNotFoundException をスローします。
`int`	`hashCode()` この実装は、基になる ServletContext リソースの場所のハッシュコードを返します。
`boolean`	`isFile()` この実装は、常に `false` を返します。
`boolean`	`isReadable()` この実装は `ServletContext.getResourceAsStream` に委譲します。読み取り不可能なリソースの場合に `null` を返します（例:

クラス org.springframework.core.io.AbstractFileResolvingResource から継承されたメソッド
contentLength, customizeConnection, customizeConnection, getFile, getFileForLastModifiedCheck, isFile, lastModified, readableChannel

クラス org.springframework.core.io.AbstractResource から継承されたメソッド
getURI, isOpen, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, finalizeSE, getClassSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.core.io.Resource から継承されたメソッド
contentLength, getURI, isOpen, lastModified, readableChannel

- コンストラクターの詳細
  - ServletContextResource
```
public ServletContextResource(ServletContextEE servletContext,
                              StringSE path)
```
    新しい ServletContextResource を作成します。
    サーブレット仕様では、多くのコンテナーがスラッシュを付けずにパスを受け入れる場合でも、リソースパスはスラッシュで始まる必要があります。指定されたパスがスラッシュで始まっていない場合は、その前にスラッシュが追加されます。
    パラメーター:
    servletContext - ロードする ServletContext
    path - リソースのパス
- メソッドの詳細
  - getServletContext
```
public final ServletContextEE getServletContext()
```
    このリソースの ServletContext を返します。
  - getPath
```
public final StringSE getPath()
```
    このリソースのパスを返します。
  - exists
```
public boolean exists()
```
    この実装は ServletContext.getResource をチェックします。
    次で指定:
    インターフェース Resource の exists
    オーバーライド:
    クラス AbstractFileResolvingResource の exists
    関連事項:
    ServletContext.getResource(String)EE
  - isReadable
```
public boolean isReadable()
```
    この実装は ServletContext.getResourceAsStream に委譲します。これは、読み取り不可能なリソース（ディレクトリなど）の場合に null を返します。
    次で指定:
    インターフェース Resource の isReadable
    オーバーライド:
    クラス AbstractFileResolvingResource の isReadable
    関連事項:
    ServletContext.getResourceAsStream(String)EE
  - isFile
```
public boolean isFile()
```
    クラスからコピーされた説明: AbstractResource
    この実装は、常に false を返します。
    次で指定:
    インターフェース Resource の isFile
    オーバーライド:
    クラス AbstractFileResolvingResource の isFile
    関連事項:
    Resource.getFile()
  - getInputStream
```
public InputStreamSE getInputStream()
                           throws IOExceptionSE
```
    この実装は ServletContext.getResourceAsStream に委譲しますが、リソースが見つからない場合は FileNotFoundException をスローします。
    次で指定:
    インターフェース InputStreamSource の getInputStream
    戻り値:
    基になるリソースの入力ストリーム (null であってはなりません)
    例外:
    FileNotFoundExceptionSE - 基になるリソースが存在しない場合
    IOExceptionSE - コンテンツストリームを開けなかった場合
    関連事項:
    ServletContext.getResourceAsStream(String)EE
  - getURL
```
public URLSE getURL()
           throws IOExceptionSE
```
    この実装は ServletContext.getResource に委譲しますが、リソースが見つからない場合は FileNotFoundException をスローします。
    次で指定:
    インターフェース Resource の getURL
    オーバーライド:
    クラス AbstractResource の getURL
    例外:
    IOExceptionSE - リソースを URL として解決できない場合、つまりリソースが記述子として利用できない場合
    関連事項:
    ServletContext.getResource(String)EE
  - getFile
```
public FileSE getFile()
             throws IOExceptionSE
```
    この実装は "file:" URL を解決するか、代わりに ServletContext.getRealPath に委譲し、見つからないか解決できない場合は FileNotFoundException をスローします。
    次で指定:
    インターフェース Resource の getFile
    オーバーライド:
    クラス AbstractFileResolvingResource の getFile
    例外:
    FileNotFoundExceptionSE - リソースが絶対ファイルパスとして解決できない場合、つまりリソースがファイルシステムで使用できない場合
    IOExceptionSE - 一般的な解決 / 読み取りエラーの場合
    関連事項:
    ServletContext.getResource(String)EE, ServletContext.getRealPath(String)EE
  - createRelative
```
public Resource createRelative(StringSE relativePath)
```
    この実装は ServletContextResource を作成し、このリソース記述子の元となるファイルのパスに対して指定されたパスを適用します。
    次で指定:
    インターフェース Resource の createRelative
    オーバーライド:
    クラス AbstractResource の createRelative
    パラメーター:
    relativePath - 相対パス (このリソースに関連して)
    戻り値:
    相対リソースのリソースハンドル
    関連事項:
    StringUtils.applyRelativePath(String, String)
  - getFilename
```
@Nullable
public StringSE getFilename()
```
    この実装は、この ServletContext リソースが参照するファイルの名前を返します。
    次で指定:
    インターフェース Resource の getFilename
    オーバーライド:
    クラス AbstractResource の getFilename
    関連事項:
    StringUtils.getFilename(String)
  - getDescription
```
public StringSE getDescription()
```
    この実装は、ServletContext リソースの場所を含む説明を返します。
    次で指定:
    インターフェース Resource の getDescription
    関連事項:
    Object.toString()SE
  - getPathWithinContext
```
public StringSE getPathWithinContext()
```
    インターフェースからコピーされた説明: ContextResource
    囲んでいる「コンテキスト」内のパスを返します。
    これは通常、コンテキスト固有のルートディレクトリへの相対パスです。ServletContext ルートまたは PortletContext ルート。
    次で指定:
    インターフェース ContextResource の getPathWithinContext
  - equals
```
public boolean equals(ObjectSE obj)
```
    この実装は、基になる ServletContext リソースの場所を比較します。
    オーバーライド:
    クラス AbstractResource の equals
    関連事項:
    Resource.getDescription()
  - hashCode
```
public int hashCode()
```
    この実装は、基になる ServletContext リソースの場所のハッシュコードを返します。
    オーバーライド:
    クラス AbstractResource の hashCode
    関連事項:
    Resource.getDescription()

クラス ServletContextResource

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.core.io.AbstractFileResolvingResource から継承されたメソッド

クラス org.springframework.core.io.AbstractResource から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.core.io.Resource から継承されたメソッド

コンストラクターの詳細

ServletContextResource

メソッドの詳細

getServletContext

getPath

exists

isReadable

isFile

getInputStream

getURL

getFile

createRelative

getFilename

getDescription

getPathWithinContext

equals

hashCode