|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Resource
Interface for a resource descriptor that abstracts from the actual type of underlying resource, such as a file or class path resource.
An InputStream can be opened for every resource if it exists in physical form, but a URL or File handle can just be returned for certain resources. The actual behavior is implementation-specific.
InputStreamSource.getInputStream()
,
getURL()
,
getURI()
,
getFile()
,
FileSystemResource
,
ClassPathResource
,
UrlResource
,
ByteArrayResource
,
InputStreamResource
,
ServletContextResource
Method Summary | |
---|---|
Resource |
createRelative(String relativePath)
Create a resource relative to this resource. |
boolean |
exists()
Return whether this resource actually exists in physical form. |
String |
getDescription()
Return a description for this resource, to be used for error output when working with the resource. |
File |
getFile()
Return a File handle for this resource. |
String |
getFilename()
Return a filename for this resource, i.e. typically the last part of the path: for example, "myfile.txt". |
URI |
getURI()
Return a URI handle for this resource. |
URL |
getURL()
Return a URL handle for this resource. |
boolean |
isOpen()
Return whether this resource represents a handle with an open stream. |
boolean |
isReadable()
Return whether the contents of this resource can be read, e.g. via InputStreamSource.getInputStream() or getFile() . |
long |
lastModified()
Determine the last-modified timestamp for this resource. |
Methods inherited from interface org.springframework.core.io.InputStreamSource |
---|
getInputStream |
Method Detail |
---|
boolean exists()
This method performs a definitive existence check, whereas the
existence of a Resource
handle only guarantees a
valid descriptor handle.
boolean isReadable()
InputStreamSource.getInputStream()
or getFile()
.
Will be true
for typical resource descriptors;
note that actual content reading may still fail when attempted.
However, a value of false
is a definitive indication
that the resource content cannot be read.
boolean isOpen()
Will be false
for typical resource descriptors.
URL getURL() throws IOException
IOException
- if the resource cannot be resolved as URL,
i.e. if the resource is not available as descriptorURI getURI() throws IOException
IOException
- if the resource cannot be resolved as URI,
i.e. if the resource is not available as descriptorFile getFile() throws IOException
IOException
- if the resource cannot be resolved as absolute
file path, i.e. if the resource is not available in a file systemlong lastModified() throws IOException
IOException
- if the resource cannot be resolved
(in the file system or as some other known physical resource type)Resource createRelative(String relativePath) throws IOException
relativePath
- the relative path (relative to this resource)
IOException
- if the relative resource cannot be determinedString getFilename()
String getDescription()
Implementations are also encouraged to return this value
from their toString
method.
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |