org.eclipse.jetty.util.resource

Class FileResource

java.lang.Object

org.eclipse.jetty.util.resource.Resource

org.eclipse.jetty.util.resource.FileResource

All Implemented Interfaces:

Closeable, AutoCloseable, ResourceFactory

public class FileResource
extends Resource

File Resource. Handle resources of implied or explicit file type. This class can check for aliasing in the filesystem (eg case insensitivity). By default this is turned on, or it can be controlled by calling the static method @see FileResource#setCheckAliases(boolean)

Field Summary

Fields inherited from class org.eclipse.jetty.util.resource.Resource

__defaultUseCaches

Constructor Summary

Constructors

Constructor and Description
FileResource(URI uri)
FileResource(URL url)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addPath(String path) Returns the resource contained inside the current resource with the given name.
void	close() Release any temporary resources held by the resource.
void	copyTo(File destination)
boolean	delete() Deletes the given resource
boolean	equals(Object o)
boolean	exists() Returns true if the resource exists.
URI	getAlias()
File	getFile() Returns an File representing the given resource or NULL if this is not possible.
InputStream	getInputStream() Returns an input stream to the resource
String	getName() Returns the name of the resource
ReadableByteChannel	getReadableByteChannel() Returns an readable bytechannel to the resource or null if one is not available.
URI	getURI() Returns an URI representing the given resource
URL	getURL() Returns an URL representing the given resource
int	hashCode()
boolean	isContainedIn(Resource r)
boolean	isDirectory() Returns true if the resource is a container/directory.
long	lastModified() Returns the last modified time
long	length() Return the length of the resource
String[]	list() Returns a list of resources contained in the given resource
boolean	renameTo(Resource dest) Rename the given resource
String	toString()

Methods inherited from class org.eclipse.jetty.util.resource.Resource

encode, finalize, getAllResources, getAssociate, getDefaultUseCaches, getListHTML, getResource, getWeakETag, isContainedIn, newClassPathResource, newClassPathResource, newResource, newResource, newResource, newResource, newResource, newSystemResource, release, setAssociate, setDefaultUseCaches, toURL, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResource

public FileResource(URL url)
             throws IOException,
                    URISyntaxException

Throws:

IOException

URISyntaxException

FileResource

public FileResource(URI uri)

Method Detail

addPath

public Resource addPath(String path)
                 throws IOException,
                        MalformedURLException

Description copied from class: Resource

Returns the resource contained inside the current resource with the given name.

Specified by:

addPath in class Resource

Parameters:

path - The path segment to add, which is not encoded

Throws:

IOException

MalformedURLException

getAlias

public URI getAlias()

Overrides:

getAlias in class Resource

Returns:

The canonical Alias of this resource or null if none.

exists

public boolean exists()

Returns true if the resource exists.

Specified by:

exists in class Resource

lastModified

public long lastModified()

Returns the last modified time

Specified by:

lastModified in class Resource

isDirectory

public boolean isDirectory()

Returns true if the resource is a container/directory.

Specified by:

isDirectory in class Resource

length

public long length()

Return the length of the resource

Specified by:

length in class Resource

getName

public String getName()

Returns the name of the resource

Specified by:

getName in class Resource

getFile

public File getFile()

Returns an File representing the given resource or NULL if this is not possible.

Specified by:

getFile in class Resource

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an input stream to the resource

Specified by:

getInputStream in class Resource

Throws:

IOException

getReadableByteChannel

public ReadableByteChannel getReadableByteChannel()
                                           throws IOException

Description copied from class: Resource

Returns an readable bytechannel to the resource or null if one is not available.

Specified by:

getReadableByteChannel in class Resource

Throws:

IOException

delete

public boolean delete()
               throws SecurityException

Deletes the given resource

Specified by:

delete in class Resource

Throws:

SecurityException

renameTo

public boolean renameTo(Resource dest)
                 throws SecurityException

Rename the given resource

Specified by:

renameTo in class Resource

Throws:

SecurityException

list

public String[] list()

Returns a list of resources contained in the given resource

Specified by:

list in class Resource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Parameters:

o -

Returns:

true of the object o is a FileResource pointing to the same file as this resource.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

the hashcode.

copyTo

public void copyTo(File destination)
            throws IOException

Overrides:

copyTo in class Resource

Throws:

IOException

isContainedIn

public boolean isContainedIn(Resource r)
                      throws MalformedURLException

Specified by:

isContainedIn in class Resource

Throws:

MalformedURLException

close

public void close()

Description copied from class: Resource

Release any temporary resources held by the resource.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Resource

getURL

public URL getURL()

Description copied from class: Resource

Returns an URL representing the given resource

Specified by:

getURL in class Resource

getURI

public URI getURI()

Description copied from class: Resource

Returns an URI representing the given resource

Overrides:

getURI in class Resource

toString

public String toString()

Overrides:

toString in class Object