@UsesJava7 public class PathResource extends AbstractResource implements WritableResource
Resource implementation for java.nio.file.Path handles.
Supports resolution as File, and also as URL.
Implements the extended WritableResource interface.Path| Constructor and Description |
|---|
PathResource(java.nio.file.Path path)
Create a new PathResource from a Path handle.
|
PathResource(java.lang.String path)
Create a new PathResource from a Path handle.
|
PathResource(java.net.URI uri)
Create a new PathResource from a Path handle.
|
| Modifier and Type | Method and Description |
|---|---|
long |
contentLength()
This implementation returns the underlying File's length.
|
Resource |
createRelative(java.lang.String relativePath)
This implementation creates a PathResource, applying the given path
relative to the path of the underlying file of this resource descriptor.
|
boolean |
equals(java.lang.Object obj)
This implementation compares the underlying Path references.
|
boolean |
exists()
This implementation returns whether the underlying file exists.
|
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()
This implementation returns the underlying File reference.
|
java.lang.String |
getFilename()
This implementation returns the name of the file.
|
java.io.InputStream |
getInputStream()
This implementation opens a InputStream for the underlying file.
|
java.io.OutputStream |
getOutputStream()
This implementation opens a OutputStream for the underlying file.
|
java.lang.String |
getPath()
Return the file path for this resource.
|
java.net.URI |
getURI()
This implementation returns a URI for the underlying file.
|
java.net.URL |
getURL()
This implementation returns a URL for the underlying file.
|
int |
hashCode()
This implementation returns the hash code of the underlying Path reference.
|
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).
|
boolean |
isWritable()
This implementation checks whether the underlying file is marked as writable
(and corresponds to an actual file with content, not to a directory).
|
long |
lastModified()
This implementation returns the underlying File's timestamp.
|
getFileForLastModifiedCheck, isOpen, toStringpublic PathResource(java.nio.file.Path path)
Note: Unlike FileSystemResource, when building relative resources
via createRelative(java.lang.String), the relative path will be built underneath
the given root: e.g. Paths.get("C:/dir1/"), relative path "dir2" -> "C:/dir1/dir2"!
path - a Path handlepublic PathResource(java.lang.String path)
Note: Unlike FileSystemResource, when building relative resources
via createRelative(java.lang.String), the relative path will be built underneath
the given root: e.g. Paths.get("C:/dir1/"), relative path "dir2" -> "C:/dir1/dir2"!
path - a pathPaths.get(String, String...)public PathResource(java.net.URI uri)
Note: Unlike FileSystemResource, when building relative resources
via createRelative(java.lang.String), the relative path will be built underneath
the given root: e.g. Paths.get("C:/dir1/"), relative path "dir2" -> "C:/dir1/dir2"!
uri - a path URIPaths.get(URI)public final java.lang.String getPath()
public boolean exists()
exists in interface Resourceexists in class AbstractResourceexists()public boolean isReadable()
isReadable in interface ResourceisReadable in class AbstractResourceFiles.isReadable(Path),
Files.isDirectory(Path, java.nio.file.LinkOption...)public java.io.InputStream getInputStream()
throws java.io.IOException
getInputStream in interface InputStreamSourcenull)java.io.FileNotFoundException - if the underlying resource doesn't existjava.io.IOException - if the content stream could not be openedFileSystemProvider.newInputStream(Path, OpenOption...)public boolean isWritable()
isWritable in interface WritableResourceFiles.isWritable(Path),
Files.isDirectory(Path, java.nio.file.LinkOption...)public java.io.OutputStream getOutputStream()
throws java.io.IOException
getOutputStream in interface WritableResourcejava.io.IOException - if the stream could not be openedFileSystemProvider.newOutputStream(Path, OpenOption...)public java.net.URL getURL()
throws java.io.IOException
getURL in interface ResourcegetURL in class AbstractResourcejava.io.IOException - if the resource cannot be resolved as URL,
i.e. if the resource is not available as descriptorPath.toUri(),
URI.toURL()public java.net.URI getURI()
throws java.io.IOException
getURI in interface ResourcegetURI in class AbstractResourcejava.io.IOException - if the resource cannot be resolved as URI,
i.e. if the resource is not available as descriptorPath.toUri()public java.io.File getFile()
throws java.io.IOException
getFile in interface ResourcegetFile in class AbstractResourcejava.io.FileNotFoundException - if the resource cannot be resolved as
absolute file path, i.e. if the resource is not available in a file systemjava.io.IOException - in case of general resolution/reading failuresInputStreamSource.getInputStream()public long contentLength()
throws java.io.IOException
contentLength in interface ResourcecontentLength in class AbstractResourcejava.io.IOException - if the resource cannot be resolved
(in the file system or as some other known physical resource type)InputStreamSource.getInputStream()public long lastModified()
throws java.io.IOException
lastModified in interface ResourcelastModified in class AbstractResourcejava.io.IOException - if the resource cannot be resolved
(in the file system or as some other known physical resource type)Files.getLastModifiedTime(Path, java.nio.file.LinkOption...)public Resource createRelative(java.lang.String relativePath) throws java.io.IOException
createRelative in interface ResourcecreateRelative in class AbstractResourcerelativePath - the relative path (relative to this resource)java.io.IOException - if the relative resource cannot be determinedPath.resolve(String)public java.lang.String getFilename()
getFilename in interface ResourcegetFilename in class AbstractResourcePath.getFileName()public java.lang.String getDescription()
ResourceImplementations are also encouraged to return this value
from their toString method.
getDescription in interface ResourceObject.toString()public boolean equals(java.lang.Object obj)
equals in class AbstractResourceResource.getDescription()public int hashCode()
hashCode in class AbstractResourceResource.getDescription()