| java.lang.Object | ||
| ↳ | org.springframework.core.io.AbstractResource | |
| ↳ | org.springframework.core.io.FileSystemResource | |
Class Overview
Resource implementation for java.io.File handles.
Obviously supports resolution as File, and also as URL.
See Also
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new FileSystemResource from a File handle.
| |||||||||||
Create a new FileSystemResource from a file path.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This implementation creates a FileSystemResource, applying the given path
relative to the path of the underlying file of this resource descriptor.
| |||||||||||
This implementation compares the underlying File references.
| |||||||||||
This implementation returns whether the underlying file exists.
| |||||||||||
This implementation returns a description that includes the absolute
path of the file.
| |||||||||||
This implementation returns the underlying File reference.
| |||||||||||
This implementation returns the name of the file.
| |||||||||||
This implementation opens a FileInputStream for the underlying file.
| |||||||||||
Return the file path for this resource.
| |||||||||||
This implementation returns a URI for the underlying file.
| |||||||||||
This implementation returns a URL for the underlying file.
| |||||||||||
This implementation returns the hash code of the underlying File reference.
| |||||||||||
This implementation checks whether the underlying file is marked as readable
(and corresponds to an actual file with content, not to a directory).
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.core.io.AbstractResource
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
org.springframework.core.io.InputStreamSource
| |||||||||||
|
From interface
org.springframework.core.io.Resource
| |||||||||||
Public Constructors
public FileSystemResource (File file)
Create a new FileSystemResource from a File handle.
Note: When building relative resources via createRelative(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.
Parameters
| file | a File handle |
|---|
public FileSystemResource (String path)
Create a new FileSystemResource from a file path.
Note: When building relative resources via createRelative(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".
Parameters
| path | a file path |
|---|
Public Methods
public Resource createRelative (String relativePath)
This implementation creates a FileSystemResource, applying the given path relative to the path of the underlying file of this resource descriptor.
Parameters
| relativePath | the relative path (relative to this resource) |
|---|
Returns
- the resource handle for the relative resource
See Also
public boolean exists ()
This implementation returns whether the underlying file exists.
See Also
public String getDescription ()
This implementation returns a description that includes the absolute path of the file.
See Also
public String getFilename ()
This implementation returns the name of the file.
See Also
public InputStream getInputStream ()
This implementation opens a FileInputStream for the underlying file.
Throws
| IOException |
|---|
See Also
- java.io.FileInputStream
public URI getURI ()
public URL getURL ()
public int hashCode ()
This implementation returns the hash code of the underlying File reference.
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).