cn.taketoday.core.io.FileSystemResource

所有已实现的接口:: InputStreamSource, OutputStreamSource, Resource, WritableResource, ThrowingConsumer<OutputStream>, Consumer<OutputStream>

直接已知子类:: FileSystemResourceLoader.FileSystemContextResource

public class FileSystemResource extends AbstractResource implements WritableResource

Resource implementation for java.io.File and java.nio.file.Path handles with a file system target. Supports resolution as a File and also as a URL. Implements the extended WritableResource interface.

Note: this Resource implementation uses NIO.2 API for read/write interactions. it may be constructed with a Path handle in which case it will perform all file system interactions via NIO.2, only resorting to File on getFile().

从以下版本开始:

2.1.6

作者:

TODAY 2019-05-14 22:50

另请参阅:

字段概要

字段

修饰符和类型

字段

说明

private final File

file

private final Path

filePath

private final String

path

从接口继承的字段 cn.taketoday.core.io.Resource
EMPTY_ARRAY
构造器概要

构造器

构造器

说明

FileSystemResource(File file)

Create a new FileSystemResource from a File handle.

FileSystemResource(String path)

Create a new FileSystemResource from a file path.

FileSystemResource(FileSystem fileSystem, String path)

Create a new FileSystemResource from a FileSystem handle, locating the specified path.

FileSystemResource(Path filePath)

Create a new FileSystemResource from a Path handle, performing all file system interactions via NIO.2 instead of File.
方法概要

修饰符和类型

方法

说明

long

contentLength()

This implementation returns the underlying File/Path length.

Resource

createRelative(String relativePath)

Create a resource relative to this resource.

boolean

equals(Object other)

boolean

exists()

This implementation returns whether the underlying file exists.

byte[]

getContentAsByteArray()

Return the contents of this resource as a byte array.

String

getContentAsString(Charset charset)

Returns the contents of this resource as a string, using the specified charset.

File

getFile()

This implementation returns the underlying File reference.

Path

getFilePath()

InputStream

getInputStream()

This implementation opens an NIO file stream for the underlying file.

String

getName()

Determine the filename for this resource — typically the last part of the path — for example, "myfile.txt".

OutputStream

getOutputStream()

This implementation opens a FileOutputStream for the underlying file.

final String

getPath()

Return the file path for this resource.

URI

getURI()

Return a URI handle for this resource.

URL

getURL()

This implementation returns a URL for the underlying file.

int

hashCode()

boolean

isDirectory()

Tests whether the resource denoted by this abstract pathname is a directory.

boolean

isFile()

This implementation always indicates a file.

boolean

isReadable()

This implementation checks whether the underlying file is marked as readable (and corresponds to an actual file with content, not to a directory).

long

lastModified()

This implementation returns the underlying File/Path last-modified time.

String[]

list()

list Resource under the directory

Resource[]

list(ResourceFilter filter)

list Resource under the directory

ReadableByteChannel

readableChannel()

This implementation opens a FileChannel for the underlying file.

String

toString()

Return a description for this resource, to be used for error output when working with the resource.

WritableByteChannel

writableChannel()

This implementation opens a FileChannel for the underlying file.

从类继承的方法 cn.taketoday.core.io.AbstractResource
customizeConnection, customizeConnection, getFileForLastModifiedCheck, isOpen

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.function.Consumer
andThen

从接口继承的方法 cn.taketoday.core.io.InputStreamSource
acceptWithException, getReader, getReader, transferTo

从接口继承的方法 cn.taketoday.core.io.OutputStreamSource
getWriter

从接口继承的方法 cn.taketoday.core.io.Resource
isOpen

从接口继承的方法 cn.taketoday.util.function.ThrowingConsumer
accept, accept, throwing

从接口继承的方法 cn.taketoday.core.io.WritableResource
isWritable

字段详细资料
- file
  
  @Nullable private final File file
- path
  
  private final String path
- filePath
  
  private final Path filePath
构造器详细资料
- FileSystemResource
  
  public FileSystemResource(String path)
  
  Create a new FileSystemResource from a file path.
  Note: When building relative resources via createRelative(java.lang.String), it makes a difference whether the specified resource base path here ends with a slash or not. In the case of "C:/dir1/", relative paths will be built underneath that root: e.g. relative path "dir2" → "C:/dir1/dir2". In the case of "C:/dir1", relative paths will apply at the same directory level: relative path "dir2" → "C:/dir2".
  参数:
  
  path - a file path
  
  另请参阅:
  
  FileSystemResource(Path)
- FileSystemResource
  
  public FileSystemResource(File file)
  
  Create a new FileSystemResource from a File handle.
  Note: When building relative resources via createRelative(java.lang.String), the relative path will apply at the same directory level: e.g. new File("C:/dir1"), relative path "dir2" → "C:/dir2"! If you prefer to have relative paths built underneath the given root directory, use the constructor with a file path to append a trailing slash to the root path: "C:/dir1/", which indicates this directory as root for all relative paths.
  参数:
  
  file - a File handle
  
  另请参阅:
  
  FileSystemResource(Path)
  
  getFile()
- FileSystemResource
  
  public FileSystemResource(Path filePath)
  
  Create a new FileSystemResource from a Path handle, performing all file system interactions via NIO.2 instead of File.
  In contrast to PathResource, this variant strictly follows the general FileSystemResource conventions, in particular in terms of path cleaning and createRelative(String) handling.
  Note: When building relative resources via createRelative(java.lang.String), the relative path will apply at the same directory level: e.g. Paths.get("C:/dir1"), relative path "dir2" → "C:/dir2"! If you prefer to have relative paths built underneath the given root directory, use the constructor with a file path to append a trailing slash to the root path: "C:/dir1/", which indicates this directory as root for all relative paths. Alternatively, consider using PathResource(Path) for java.nio.path.Path resolution in createRelative, always nesting relative paths.
  参数:
  
  filePath - a Path handle to a file
  
  另请参阅:
  
  FileSystemResource(File)
- FileSystemResource
  
  public FileSystemResource(FileSystem fileSystem, String path)
  
  Create a new FileSystemResource from a FileSystem handle, locating the specified path.
  This is an alternative to FileSystemResource(String), performing all file system interactions via NIO.2 instead of File.
  参数:
  
  fileSystem - the FileSystem to locate the path within
  
  path - a file path
  
  从以下版本开始:
  
  4.0
  
  另请参阅:
  
  FileSystemResource(File)
方法详细资料
- getPath
  
  public final String getPath()
  
  Return the file path for this resource.
- getFilePath
  
  public Path getFilePath()
  
  从以下版本开始:
  
  4.0
- exists
  
  public boolean exists()
  
  This implementation returns whether the underlying file exists.
  指定者:
  
  exists 在接口中 Resource
  
  覆盖:
  
  exists 在类中 AbstractResource
  
  另请参阅:
  
  File.exists()
  
  Files.exists(Path, java.nio.file.LinkOption...)
- getInputStream
  
  public InputStream getInputStream() throws IOException
  
  This implementation opens an NIO file stream for the underlying file.
  指定者:
  
  getInputStream 在接口中 InputStreamSource
  
  返回:
  
  the input stream for the underlying resource (must not be null)
  
  抛出:
  
  FileNotFoundException - if the underlying resource does not exist
  
  IOException - if the content stream could not be opened
  
  另请参阅:
  
  Files.newInputStream(Path, java.nio.file.OpenOption...)
- getContentAsByteArray
  
  public byte[] getContentAsByteArray() throws IOException
  
  从接口复制的说明: Resource
  
  Return the contents of this resource as a byte array.
  
  指定者:
  
  getContentAsByteArray 在接口中 Resource
  
  返回:
  
  the contents of this resource as byte array
  
  抛出:
  
  FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system
  
  IOException - in case of general resolution/reading failures
- getContentAsString
  
  public String getContentAsString(Charset charset) throws IOException
  
  从接口复制的说明: Resource
  
  Returns the contents of this resource as a string, using the specified charset.
  
  指定者:
  
  getContentAsString 在接口中 Resource
  
  参数:
  
  charset - the charset to use for decoding
  
  返回:
  
  the contents of this resource as a String
  
  抛出:
  
  FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system
  
  IOException - in case of general resolution/reading failures
- getOutputStream
  
  public OutputStream getOutputStream() throws IOException
  
  This implementation opens a FileOutputStream for the underlying file.
  指定者:
  
  getOutputStream 在接口中 OutputStreamSource
  
  抛出:
  
  IOException - if the stream could not be opened
  
  另请参阅:
  
  FileOutputStream
- getURL
  
  public URL getURL() throws IOException
  
  This implementation returns a URL for the underlying file.
  
  指定者:
  
  getURL 在接口中 Resource
  
  覆盖:
  
  getURL 在类中 AbstractResource
  
  抛出:
  
  IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as a descriptor
- getURI
  
  public URI getURI() throws IOException
  
  Return a URI handle for this resource.
  
  指定者:
  
  getURI 在接口中 Resource
  
  覆盖:
  
  getURI 在类中 AbstractResource
  
  抛出:
  
  IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as a descriptor
- getFile
  
  public File getFile()
  
  This implementation returns the underlying File reference.
  指定者:
  
  getFile 在接口中 Resource
  
  覆盖:
  
  getFile 在类中 AbstractResource
  
  另请参阅:
  
  InputStreamSource.getInputStream()
- isFile
  
  public boolean isFile()
  
  This implementation always indicates a file.
  指定者:
  
  isFile 在接口中 Resource
  
  覆盖:
  
  isFile 在类中 AbstractResource
  
  另请参阅:
  
  Resource.getFile()
- isDirectory
  
  public boolean isDirectory() throws IOException
  
  从接口复制的说明: Resource
  
  Tests whether the resource denoted by this abstract pathname is a directory.
  Where it is required to distinguish an I/O exception from the case that the file is not a directory, or where several attributes of the same file are required at the same time, then the Files.readAttributes method may be used.
  
  指定者:
  
  isDirectory 在接口中 Resource
  
  覆盖:
  
  isDirectory 在类中 AbstractResource
  
  返回:
  
  true if and only if the file denoted by this abstract pathname exists and is a directory; false otherwise
  
  抛出:
  
  SecurityException - If a security manager exists and its SecurityManager.checkRead(java.lang.String) method denies read access to the file
  
  IOException - cannot determine resource
- contentLength
  
  public long contentLength() throws IOException
  
  This implementation returns the underlying File/Path length.
  指定者:
  
  contentLength 在接口中 Resource
  
  覆盖:
  
  contentLength 在类中 AbstractResource
  
  抛出:
  
  IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  
  另请参阅:
  
  InputStreamSource.getInputStream()
- lastModified
  
  public long lastModified() throws IOException
  
  This implementation returns the underlying File/Path last-modified time.
  指定者:
  
  lastModified 在接口中 Resource
  
  覆盖:
  
  lastModified 在类中 AbstractResource
  
  抛出:
  
  IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  
  另请参阅:
  
  AbstractResource.getFileForLastModifiedCheck()
- createRelative
  
  public Resource createRelative(String relativePath) throws IOException
  
  从接口复制的说明: Resource
  
  Create a resource relative to this resource.
  
  指定者:
  
  createRelative 在接口中 Resource
  
  覆盖:
  
  createRelative 在类中 AbstractResource
  
  参数:
  
  relativePath - the relative path (relative to this resource)
  
  返回:
  
  the resource handle for the relative resource
  
  抛出:
  
  IOException - if the relative resource cannot be determined
- list
  
  public String[] list() throws IOException
  
  从接口复制的说明: Resource
  
  list Resource under the directory
  
  指定者:
  
  list 在接口中 Resource
  
  覆盖:
  
  list 在类中 AbstractResource
  
  返回:
  
  Resource names
  
  抛出:
  
  IOException - if the resource is not available
- list
  
  public Resource[] list(ResourceFilter filter) throws IOException
  
  从接口复制的说明: Resource
  
  list Resource under the directory
  
  指定者:
  
  list 在接口中 Resource
  
  覆盖:
  
  list 在类中 AbstractResource
  
  参数:
  
  filter - filter Resource
  
  返回:
  
  Resource names
  
  抛出:
  
  IOException - if the resource is not available
- getName
  
  public String getName()
  
  从类复制的说明: AbstractResource
  
  Determine the filename for this resource — typically the last part of the path — for example, "myfile.txt".
  Returns null if this type of resource does not have a filename.
  Implementations are encouraged to return the filename unencoded.
  
  指定者:
  
  getName 在接口中 Resource
  
  覆盖:
  
  getName 在类中 AbstractResource
- readableChannel
  
  public ReadableByteChannel readableChannel() throws IOException
  
  This implementation opens a FileChannel for the underlying file.
  指定者:
  
  readableChannel 在接口中 InputStreamSource
  
  返回:
  
  the byte channel for the underlying resource (must not be null)
  
  抛出:
  
  FileNotFoundException - if the underlying resource doesn't exist
  
  IOException - if the content channel could not be opened
  
  另请参阅:
  
  FileChannel
- writableChannel
  
  public WritableByteChannel writableChannel() throws IOException
  
  This implementation opens a FileChannel for the underlying file.
  指定者:
  
  writableChannel 在接口中 OutputStreamSource
  
  返回:
  
  the byte channel for the underlying resource (must not be null)
  
  抛出:
  
  FileNotFoundException - if the underlying resource doesn't exist
  
  IOException - if the content channel could not be opened
  
  另请参阅:
  
  FileChannel
- isReadable
  
  public boolean isReadable()
  
  This implementation checks whether the underlying file is marked as readable (and corresponds to an actual file with content, not to a directory).
  指定者:
  
  isReadable 在接口中 Resource
  
  覆盖:
  
  isReadable 在类中 AbstractResource
  
  另请参阅:
  
  File.canRead()
  
  File.isDirectory()
  
  Files.isReadable(Path)
  
  Files.isDirectory(Path, java.nio.file.LinkOption...)
- equals
  
  public boolean equals(Object other)
  
  覆盖:
  
  equals 在类中 AbstractResource
- hashCode
  
  public int hashCode()
  
  覆盖:
  
  hashCode 在类中 AbstractResource
- toString
  
  public String toString()
  
  从接口复制的说明: Resource
  
  Return a description for this resource, to be used for error output when working with the resource.
  Implementations are also encouraged to return this value from their toString method.
  指定者:
  
  toString 在接口中 Resource
  
  覆盖:
  
  toString 在类中 AbstractResource
  
  另请参阅:
  
  Object.toString()

类 FileSystemResource

字段概要

从接口继承的字段 cn.taketoday.core.io.Resource

构造器概要

方法概要

从类继承的方法 cn.taketoday.core.io.AbstractResource

从类继承的方法 java.lang.Object

从接口继承的方法 java.util.function.Consumer

从接口继承的方法 cn.taketoday.core.io.InputStreamSource

从接口继承的方法 cn.taketoday.core.io.OutputStreamSource

从接口继承的方法 cn.taketoday.core.io.Resource

从接口继承的方法 cn.taketoday.util.function.ThrowingConsumer

从接口继承的方法 cn.taketoday.core.io.WritableResource

字段详细资料

file

path

filePath

构造器详细资料

FileSystemResource

FileSystemResource

FileSystemResource

FileSystemResource

方法详细资料

getPath

getFilePath

exists

getInputStream

getContentAsByteArray

getContentAsString

getOutputStream

getURL

getURI

getFile

isFile

isDirectory

contentLength

lastModified

createRelative

list

list

getName

readableChannel

writableChannel

isReadable

equals

hashCode

toString