Groovy Documentation

org.codehaus.groovy.grails.io.support
[Java] Class FileSystemResource

java.lang.Object
  org.codehaus.groovy.grails.io.support.FileSystemResource
All Implemented Interfaces:
Resource

public class FileSystemResource
extends java.lang.Object

Based on Spring FileSystemResource implementation.

Authors:
Juergen Hoeller
Graeme Rocher
See Also:
java.io.File
Since:
28.12.2003


Constructor Summary
FileSystemResource(java.io.File file)

Create a new FileSystemResource from a File handle.

FileSystemResource(java.lang.String path)

Create a new FileSystemResource from a file path.

 
Method Summary
protected void assertNotNull(java.lang.Object object, java.lang.String message)

long contentLength()

This implementation returns the underlying File's length.

Resource createRelative(java.lang.String relativePath)

This implementation creates a FileSystemResource, 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 File references.

boolean exists()

This implementation returns whether the underlying file exists.

java.lang.String getDescription()

This implementation returns a description that includes the absolute path of the file.

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 FileInputStream for the underlying file.

java.io.OutputStream getOutputStream()

This implementation opens a FileOutputStream 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 File 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()

java.lang.String toString()

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Constructor Detail

FileSystemResource

public FileSystemResource(java.io.File file)
Create a new FileSystemResource from a File handle.
Parameters:
file - a File handle


FileSystemResource

public FileSystemResource(java.lang.String path)
Create a new FileSystemResource from a file path.
Parameters:
path - a file path


 
Method Detail

assertNotNull

protected void assertNotNull(java.lang.Object object, java.lang.String message)


contentLength

public long contentLength()
This implementation returns the underlying File's length.


createRelative

public Resource createRelative(java.lang.String relativePath)
This implementation creates a FileSystemResource, applying the given path relative to the path of the underlying file of this resource descriptor.


equals

public boolean equals(Object obj) {
public boolean equals(java.lang.Object obj)
This implementation compares the underlying File references.


exists

public boolean exists()
This implementation returns whether the underlying file exists.
See Also:
java.io.File#exists()


getDescription

public java.lang.String getDescription()
This implementation returns a description that includes the absolute path of the file.
See Also:
java.io.File#getAbsolutePath()


getFile

public java.io.File getFile()
This implementation returns the underlying File reference.


getFilename

public java.lang.String getFilename()
This implementation returns the name of the file.
See Also:
java.io.File#getName()


getInputStream

public java.io.InputStream getInputStream()
This implementation opens a FileInputStream for the underlying file.
See Also:
java.io.FileInputStream


getOutputStream

public java.io.OutputStream getOutputStream()
This implementation opens a FileOutputStream for the underlying file.
See Also:
java.io.FileOutputStream


getPath

public final java.lang.String getPath()
Return the file path for this resource.


getURI

public java.net.URI getURI()
This implementation returns a URI for the underlying file.
See Also:
java.io.File#toURI()


getURL

public java.net.URL getURL()
This implementation returns a URL for the underlying file.
See Also:
java.io.File#toURI()


hashCode

public int hashCode() {
public int hashCode()
This implementation returns the hash code of the underlying File reference.


isReadable

public 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).
See Also:
java.io.File#canRead()
java.io.File#isDirectory()


isWritable

public 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).
See Also:
java.io.File#canWrite()
java.io.File#isDirectory()


lastModified

public long lastModified()


toString

public String toString() {
public java.lang.String toString()


 

Groovy Documentation