org.springframework.core.io.AbstractResource

org.springframework.core.io.PathResource

All Implemented Interfaces:: InputStreamSource, Resource, WritableResource

@Deprecated(since="7.0", forRemoval=true) public class PathResource extends AbstractResource implements WritableResource

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor of FileSystemResource

Resource implementation for Path handles, performing all operations and transformations via the Path API. Supports resolution as a File and also as a URL. Implements the extended WritableResource interface.

Note: As of 5.1, Path support is also available in FileSystemResource, applying Spring's standard String-based path transformations but performing all operations via the Files API. This PathResource is effectively a pure java.nio.path.Path based alternative with different createRelative behavior.

Since:

4.0

Author:

Philippe Marschall, Juergen Hoeller

See Also:

Constructor Summary

Constructors

Constructor

Description

PathResource(String path)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new PathResource from a path string.

PathResource(URI uri)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new PathResource from a URI.

PathResource(Path path)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new PathResource from a Path handle.
Method Summary

Modifier and Type

Method

Description

long

contentLength()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the underlying file's length.

Resource

createRelative(String relativePath)

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation creates a PathResource, applying the given path relative to the path of the underlying file of this resource descriptor.

boolean

equals(@Nullable Object other)

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation compares the underlying Path references.

boolean

exists()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns whether the underlying file exists.

byte[]

getContentAsByteArray()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the contents of this resource as a byte array.

String

getContentAsString(Charset charset)

Deprecated, for removal: This API element is subject to removal in a future version.

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

String

getDescription()

Deprecated, for removal: This API element is subject to removal in a future version.

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

File

getFile()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the underlying File reference.

String

getFilename()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the name of the file.

Path

getFilePath()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the underlying Path reference.

InputStream

getInputStream()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation opens an InputStream for the underlying file.

OutputStream

getOutputStream()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation opens an OutputStream for the underlying file.

final String

getPath()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the file path for this resource.

URI

getURI()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns a URI for the underlying file.

URL

getURL()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns a URL for the underlying file.

int

hashCode()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the hash code of the underlying Path reference.

boolean

isFile()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation always indicates a file.

boolean

isReadable()

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation returns the underlying file's timestamp.

ReadableByteChannel

readableChannel()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation opens a ReadableByteChannel for the underlying file.

WritableByteChannel

writableChannel()

Deprecated, for removal: This API element is subject to removal in a future version.

This implementation opens a WritableByteChannel for the underlying file.

Methods inherited from class AbstractResource
getFileForLastModifiedCheck, isOpen, toString

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Resource
isOpen

Constructor Details
- PathResource
  
  public PathResource(Path path)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Create a new PathResource from a Path handle.
  Note: Unlike FileSystemResource, when building relative resources via createRelative(String), the relative path will be built underneath the given root: for example, Paths.get("C:/dir1/"), relative path "dir2" → "C:/dir1/dir2"!
  
  Parameters:
  
  path - a Path handle
- PathResource
  public PathResource(String path)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Create a new PathResource from a path string.
  Note: Unlike FileSystemResource, when building relative resources via createRelative(String), the relative path will be built underneath the given root: for example, Paths.get("C:/dir1/"), relative path "dir2" → "C:/dir1/dir2"!
  
  Parameters:
  
  path - a path
  
  See Also:
  
  Paths.get(String, String...)
- PathResource
  public PathResource(URI uri)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Create a new PathResource from a URI.
  Note: Unlike FileSystemResource, when building relative resources via createRelative(String), the relative path will be built underneath the given root: for example, Paths.get("C:/dir1/"), relative path "dir2" → "C:/dir1/dir2"!
  
  Parameters:
  
  uri - a path URI
  
  See Also:
  
  Paths.get(URI)
Method Details
- getPath
  
  public final String getPath()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Return the file path for this resource.
- exists
  public boolean exists()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns whether the underlying file exists.
  
  Specified by:
  
  exists in interface Resource
  
  Overrides:
  
  exists in class AbstractResource
  
  See Also:
  
  Files.exists(Path, java.nio.file.LinkOption...)
- isReadable
  public boolean isReadable()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation checks whether the underlying file is marked as readable (and corresponds to an actual file with content, not to a directory).
  
  Specified by:
  
  isReadable in interface Resource
  
  Overrides:
  
  isReadable in class AbstractResource
  
  See Also:
  
  Files.isReadable(Path)
  
  Files.isDirectory(Path, java.nio.file.LinkOption...)
- getInputStream
  public InputStream getInputStream() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation opens an InputStream for the underlying file.
  
  Specified by:
  
  getInputStream in interface InputStreamSource
  
  Returns:
  
  the input stream for the underlying resource (must not be null)
  
  Throws:
  
  IOException - if the content stream could not be opened
  
  See Also:
  
  FileSystemProvider.newInputStream(Path, OpenOption...)
- getContentAsByteArray
  
  public byte[] getContentAsByteArray() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: Resource
  
  Return the contents of this resource as a byte array.
  
  Specified by:
  
  getContentAsByteArray in interface Resource
  
  Returns:
  
  the contents of this resource as byte array
  
  Throws:
  
  IOException - in case of general resolution/reading failures
- getContentAsString
  
  public String getContentAsString(Charset charset) throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: Resource
  
  Return the contents of this resource as a string, using the specified charset.
  
  Specified by:
  
  getContentAsString in interface Resource
  
  Parameters:
  
  charset - the charset to use for decoding
  
  Returns:
  
  the contents of this resource as a String
  
  Throws:
  
  IOException - in case of general resolution/reading failures
- isWritable
  public boolean isWritable()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation checks whether the underlying file is marked as writable (and corresponds to an actual file with content, not to a directory).
  
  Specified by:
  
  isWritable in interface WritableResource
  
  See Also:
  
  Files.isWritable(Path)
  
  Files.isDirectory(Path, java.nio.file.LinkOption...)
- getOutputStream
  public OutputStream getOutputStream() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation opens an OutputStream for the underlying file.
  
  Specified by:
  
  getOutputStream in interface WritableResource
  
  Throws:
  
  IOException - if the stream could not be opened
  
  See Also:
  
  FileSystemProvider.newOutputStream(Path, OpenOption...)
- getURL
  public URL getURL() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns a URL for the underlying file.
  
  Specified by:
  
  getURL in interface Resource
  
  Overrides:
  
  getURL in class AbstractResource
  
  Throws:
  
  IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as a descriptor
  
  See Also:
  
  Path.toUri()
  
  URI.toURL()
- getURI
  public URI getURI() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns a URI for the underlying file.
  
  Specified by:
  
  getURI in interface Resource
  
  Overrides:
  
  getURI in class AbstractResource
  
  Throws:
  
  IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as a descriptor
  
  See Also:
  
  Path.toUri()
- isFile
  public boolean isFile()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation always indicates a file.
  
  Specified by:
  
  isFile in interface Resource
  
  Overrides:
  
  isFile in class AbstractResource
  
  See Also:
  
  Resource.getFile()
  
  Resource.getFilePath()
- getFile
  public File getFile()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the underlying File reference.
  
  Specified by:
  
  getFile in interface Resource
  
  Overrides:
  
  getFile in class AbstractResource
  
  See Also:
  
  InputStreamSource.getInputStream()
- getFilePath
  
  public Path getFilePath()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the underlying Path reference.
  
  Specified by:
  
  getFilePath in interface Resource
- readableChannel
  public ReadableByteChannel readableChannel() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation opens a ReadableByteChannel for the underlying file.
  
  Specified by:
  
  readableChannel in interface Resource
  
  Overrides:
  
  readableChannel in class AbstractResource
  
  Returns:
  
  the byte channel for the underlying resource (must not be null)
  
  Throws:
  
  IOException - if the content channel could not be opened
  
  See Also:
  
  Files.newByteChannel(Path, OpenOption...)
- writableChannel
  public WritableByteChannel writableChannel() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation opens a WritableByteChannel for the underlying file.
  
  Specified by:
  
  writableChannel in interface WritableResource
  
  Returns:
  
  the byte channel for the underlying resource (must not be null)
  
  Throws:
  
  IOException - if the content channel could not be opened
  
  See Also:
  
  Files.newByteChannel(Path, OpenOption...)
- contentLength
  public long contentLength() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the underlying file's length.
  
  Specified by:
  
  contentLength in interface Resource
  
  Overrides:
  
  contentLength in class AbstractResource
  
  Throws:
  
  IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  
  See Also:
  
  InputStreamSource.getInputStream()
- lastModified
  public long lastModified() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the underlying file's timestamp.
  
  Specified by:
  
  lastModified in interface Resource
  
  Overrides:
  
  lastModified in class AbstractResource
  
  Throws:
  
  IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  
  See Also:
  
  Files.getLastModifiedTime(Path, java.nio.file.LinkOption...)
- createRelative
  public Resource createRelative(String relativePath)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation creates a PathResource, applying the given path relative to the path of the underlying file of this resource descriptor.
  
  Specified by:
  
  createRelative in interface Resource
  
  Overrides:
  
  createRelative in class AbstractResource
  
  Parameters:
  
  relativePath - the relative path (relative to this resource)
  
  Returns:
  
  the resource handle for the relative resource
  
  See Also:
  
  Path.resolve(String)
- getFilename
  public String getFilename()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the name of the file.
  
  Specified by:
  
  getFilename in interface Resource
  
  Overrides:
  
  getFilename in class AbstractResource
  
  See Also:
  
  Path.getFileName()
- getDescription
  public String getDescription()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: 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.
  
  Specified by:
  
  getDescription in interface Resource
  
  See Also:
  
  Object.toString()
- equals
  public boolean equals(@Nullable Object other)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation compares the underlying Path references.
  
  Overrides:
  
  equals in class AbstractResource
  
  See Also:
  
  Resource.getDescription()
- hashCode
  public int hashCode()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  This implementation returns the hash code of the underlying Path reference.
  
  Overrides:
  
  hashCode in class AbstractResource
  
  See Also:
  
  Resource.getDescription()

Class PathResource

Constructor Summary

Method Summary

Methods inherited from class AbstractResource

Methods inherited from class Object

Methods inherited from interface Resource

Constructor Details

PathResource

PathResource

PathResource

Method Details

getPath

exists

isReadable

getInputStream

getContentAsByteArray

getContentAsString

isWritable

getOutputStream

getURL

getURI

isFile

getFile

getFilePath

readableChannel

writableChannel

contentLength

lastModified

createRelative

getFilename

getDescription

equals

hashCode