クラス PathResource

メソッドの詳細

• getPath

  public final StringSE getPath()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  このリソースのファイルパスを返します。

• exists

  public boolean exists()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、元となるファイルが存在するかどうかを返します。

  次で指定:

  インターフェース Resource の exists 

  オーバーライド:

  クラス AbstractResource の exists 

  関連事項:

  • Files.exists(Path, java.nio.file.LinkOption...)SE

• isReadable

  public boolean isReadable()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、元となるファイルが読み取り可能としてマークされているかどうかを確認します（ディレクトリではなく、コンテンツを含む実際のファイルに対応します）。

  次で指定:

  インターフェース Resource の isReadable 

  オーバーライド:

  クラス AbstractResource の isReadable 

  関連事項:

  • Files.isReadable(Path)SE
  • Files.isDirectory(Path, java.nio.file.LinkOption...)SE

• getInputStream

  public InputStreamSE getInputStream() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、基になるファイルの InputStreamSE を開きます。

  次で指定:

  インターフェース InputStreamSource の getInputStream 

  戻り値:

  基になるリソースの入力ストリーム (null であってはなりません)

  例外:

  IOExceptionSE - コンテンツストリームを開けなかった場合

  関連事項:

  • FileSystemProvider.newInputStream(Path, OpenOption...)SE

• getContentAsByteArray

  public byte[] getContentAsByteArray() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  インターフェースからコピーされた説明: Resource

  このリソースの内容をバイト配列として返します。

  次で指定:

  インターフェース Resource の getContentAsByteArray 

  戻り値:

  バイト配列としてのこのリソースの内容

  例外:

  IOExceptionSE - 一般的な解決 / 読み取りエラーの場合

• getContentAsString

  public StringSE getContentAsString(CharsetSE charset) throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  インターフェースからコピーされた説明: Resource

  指定された文字セットを使用して、このリソースの内容を文字列として返します。

  次で指定:

  インターフェース Resource の getContentAsString 

  パラメーター:

  charset - デコードに使用する文字セット

  戻り値:

  このリソースの内容を String として

  例外:

  IOExceptionSE - 一般的な解決 / 読み取りエラーの場合

• isWritable

  public boolean isWritable()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、元となるファイルが書き込み可能としてマークされているかどうかを確認します（また、ディレクトリではなくコンテンツを含む実際のファイルに対応します）。

  次で指定:

  インターフェース WritableResource の isWritable 

  関連事項:

  • Files.isWritable(Path)SE
  • Files.isDirectory(Path, java.nio.file.LinkOption...)SE

• getOutputStream

  public OutputStreamSE getOutputStream() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、基になるファイルの OutputStreamSE を開きます。

  次で指定:

  インターフェース WritableResource の getOutputStream 

  例外:

  IOExceptionSE - ストリームを開けなかった場合

  関連事項:

  • FileSystemProvider.newOutputStream(Path, OpenOption...)SE

• getURL

  public URLSE getURL() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基になるファイルの URLSE を返します。

  次で指定:

  インターフェース Resource の getURL 

  オーバーライド:

  クラス AbstractResource の getURL 

  例外:

  IOExceptionSE - リソースを URL として解決できない場合、つまりリソースが記述子として使用できない場合

  関連事項:

  • Path.toUri()
  • URI.toURL()

• getURI

  public URISE getURI() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基になるファイルの URISE を返します。

  次で指定:

  インターフェース Resource の getURI 

  オーバーライド:

  クラス AbstractResource の getURI 

  例外:

  IOExceptionSE - リソースを URI として解決できない場合、つまりリソースが記述子として使用できない場合

  関連事項:

  • Path.toUri()

• isFile

  public boolean isFile()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は常にファイルを示します。

  次で指定:

  インターフェース Resource の isFile 

  オーバーライド:

  クラス AbstractResource の isFile 

  関連事項:

  • Resource.getFile()
  • Resource.getFilePath()

• getFile

  public FileSE getFile()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基礎となる FileSE 参照を返します。

  次で指定:

  インターフェース Resource の getFile 

  オーバーライド:

  クラス AbstractResource の getFile 

  関連事項:

  • InputStreamSource.getInputStream()

• getFilePath

  public PathSE getFilePath()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基礎となる PathSE 参照を返します。

  次で指定:

  インターフェース Resource の getFilePath 

• readableChannel

  public ReadableByteChannelSE readableChannel() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、基になるファイルの ReadableByteChannelSE を開きます。

  次で指定:

  インターフェース Resource の readableChannel 

  オーバーライド:

  クラス AbstractResource の readableChannel 

  戻り値:

  基になるリソースのバイトチャネル (null であってはなりません)

  例外:

  IOExceptionSE - コンテンツチャネルを開けなかった場合

  関連事項:

  • Files.newByteChannel(Path, OpenOption...)SE

• writableChannel

  public WritableByteChannelSE writableChannel() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、基になるファイルの WritableByteChannelSE を開きます。

  次で指定:

  インターフェース WritableResource の writableChannel 

  戻り値:

  基になるリソースのバイトチャネル (null であってはなりません)

  例外:

  IOExceptionSE - コンテンツチャネルを開けなかった場合

  関連事項:

  • Files.newByteChannel(Path, OpenOption...)SE

• contentLength

  public long contentLength() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、元となるファイルの長さを返します。

  次で指定:

  インターフェース Resource の contentLength 

  オーバーライド:

  クラス AbstractResource の contentLength 

  例外:

  IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)

  関連事項:

  • InputStreamSource.getInputStream()

• lastModified

  public long lastModified() throws IOExceptionSE

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基になるファイルのタイムスタンプを返します。

  次で指定:

  インターフェース Resource の lastModified 

  オーバーライド:

  クラス AbstractResource の lastModified 

  例外:

  IOExceptionSE - リソースを解決できない場合 (ファイルシステム内、または他の既知の物理リソース型として)

  関連事項:

  • Files.getLastModifiedTime(Path, java.nio.file.LinkOption...)SE

• createRelative

  public Resource createRelative(StringSE relativePath)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、このリソース記述子の元となるファイルのパスに相対的な指定されたパスを適用して、PathResource を作成します。

  次で指定:

  インターフェース Resource の createRelative 

  オーバーライド:

  クラス AbstractResource の createRelative 

  パラメーター:

  relativePath - 相対パス (このリソースに関連して)

  戻り値:

  相対リソースのリソースハンドル

  関連事項:

  • Path.resolve(String)SE

• getFilename

  public StringSE getFilename()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、ファイルの名前を返します。

  次で指定:

  インターフェース Resource の getFilename 

  オーバーライド:

  クラス AbstractResource の getFilename 

  関連事項:

  • Path.getFileName()

• getDescription

  public StringSE getDescription()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  インターフェースからコピーされた説明: Resource

  このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。

  実装では、toString メソッドからこの値を返すことも推奨されます。

  次で指定:

  インターフェース Resource の getDescription 

  関連事項:

  • Object.toString()

• equals

  public boolean equals(@Nullable ObjectSE other)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装では、基礎となる PathSE 参照を比較します。

  オーバーライド:

  クラス AbstractResource の equals 

  関連事項:

  • Resource.getDescription()

• hashCode

  public int hashCode()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  この実装は、基礎となる PathSE 参照のハッシュコードを返します。

  オーバーライド:

  クラス AbstractResource の hashCode 

  関連事項:

  • Resource.getDescription()