|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for a resource descriptor that abstracts from the actual type of resource, like 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.
Method Summary | |
Resource |
createRelative(java.lang.String relativePath)
Create a resource relative to this resource. |
boolean |
exists()
Return whether this resource actually exists in physical form. |
java.lang.String |
getDescription()
Return a description for this resource, to be used for error output when working with the resource. |
java.io.File |
getFile()
Return a File handle for this resource. |
java.lang.String |
getFilename()
Return a filename for this resource, i.e. typically the last part of the path: for example, "myfile.txt". |
java.net.URL |
getURL()
Return a URL handle for this resource. |
boolean |
isOpen()
Return whether this resource represents a handle with an open stream. |
Methods inherited from interface org.springframework.core.io.InputStreamSource |
getInputStream |
Method Detail |
public boolean exists()
public boolean isOpen()
Will be false for all usual resource descriptors.
public java.net.URL getURL() throws java.io.IOException
java.io.IOException
- if the resource cannot be resolved as URL,
i.e. if the resource is not available as descriptorpublic java.io.File getFile() throws java.io.IOException
java.io.IOException
- if the resource cannot be resolved as absolute
file path, i.e. if the resource is not available in a file systempublic Resource createRelative(java.lang.String relativePath) throws java.io.IOException
relativePath
- the relative path (relative to this resource)
java.io.IOException
- if the relative resource cannot be determinedpublic java.lang.String getFilename()
public java.lang.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 |