org.springframework.core.io
Class FileSystemResource

java.lang.Object
  org.springframework.core.io.AbstractResource
      org.springframework.core.io.FileSystemResource

All Implemented Interfaces:

InputStreamSource, Resource

public class FileSystemResource
extends AbstractResource

Resource implementation for java.io.File handles. Obviously supports resolution as File, and also as URL.

Since:

28.12.2003

Author:

Juergen Hoeller

See Also:

File

Constructor Summary

FileSystemResource(File file)
Create a new FileSystemResource.

FileSystemResource(String path)
Create a new FileSystemResource.

Method Summary

Resource	createRelative(String relativePath) This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.
boolean	equals(Object obj) This implementation compares description strings.
boolean	exists() This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.
String	getDescription() This abstract method declaration shadows the method in the Resource interface.
File	getFile() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.
String	getFilename() This implementation always throws IllegalStateException, assuming that the resource does not carry a filename.
InputStream	getInputStream() Return an InputStream.
URL	getURL() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.
int	hashCode() This implementation returns the description's hash code.

Methods inherited from class org.springframework.core.io.AbstractResource

isOpen, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileSystemResource

public FileSystemResource(File file)

Create a new FileSystemResource.

Parameters:

file - a File handle

FileSystemResource

public FileSystemResource(String path)

Create a new FileSystemResource.

Parameters:

path - a file path

Method Detail

exists

public boolean exists()

Description copied from class: AbstractResource

This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened. This will cover both directories and content resources.

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractResource

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: InputStreamSource

Return an InputStream. It is expected that each call creates a fresh stream.

Throws:

IOException - if the stream could not be opened

getURL

public URL getURL()
           throws IOException

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.

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 descriptor

getFile

public File getFile()

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.

Specified by:

getFile in interface Resource

Overrides:

getFile in class AbstractResource

createRelative

public Resource createRelative(String relativePath)

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.

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

getFilename

public String getFilename()

Description copied from class: AbstractResource

This implementation always throws IllegalStateException, assuming that the resource does not carry a filename.

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

getDescription

public String getDescription()

Description copied from class: AbstractResource

This abstract method declaration shadows the method in the Resource interface. This is necessary to make the toString implementation in this class work on Sun's JDK 1.3 classic VM, which can't find the getDescription method when executing toString else.

Specified by:

getDescription in interface Resource

Specified by:

getDescription in class AbstractResource

See Also:

Resource.getDescription()

equals

public boolean equals(Object obj)

Description copied from class: AbstractResource

This implementation compares description strings.

Overrides:

equals in class AbstractResource

See Also:

AbstractResource.getDescription()

hashCode

public int hashCode()

Description copied from class: AbstractResource

This implementation returns the description's hash code.

Overrides:

hashCode in class AbstractResource

See Also:

AbstractResource.getDescription()