org.eclipse.jetty.util.resource

Class PathResource

java.lang.Object

org.eclipse.jetty.util.resource.Resource

org.eclipse.jetty.util.resource.PathResource

All Implemented Interfaces:

Closeable, AutoCloseable, ResourceFactory

public class PathResource
extends Resource

Java NIO Path equivalent of FileResource.

Field Summary

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

__defaultUseCaches

Constructor Summary

Constructors

Constructor and Description
PathResource(File file)
PathResource(Path path)
PathResource(URI uri)
PathResource(URL url)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addPath(String apath) Returns the resource contained inside the current resource with the given name.
void	close() Release any temporary resources held by the resource.
boolean	delete() Deletes the given resource
boolean	equals(Object obj)
boolean	exists() Returns true if the respresened resource exists.
URI	getAlias()
File	getFile() Returns an File representing the given resource or NULL if this is not possible.
boolean	getFollowLinks()
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 respresenetd 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 resource names contained in the given resource The resource names are not URL encoded.
boolean	renameTo(Resource dest) Rename the given resource
void	setFollowLinks(boolean followLinks)

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

copyTo, 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, toString, wait, wait, wait

Constructor Detail

PathResource

public PathResource(File file)

PathResource

public PathResource(Path path)

PathResource

public PathResource(URI uri)
             throws IOException

Throws:

IOException

PathResource

public PathResource(URL url)
             throws IOException,
                    URISyntaxException

Throws:

IOException

URISyntaxException

Method Detail

addPath

public Resource addPath(String apath)
                 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:

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

Throws:

IOException

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

delete

public boolean delete()
               throws SecurityException

Description copied from class: Resource

Deletes the given resource

Specified by:

delete in class Resource

Throws:

SecurityException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

exists

public boolean exists()

Description copied from class: Resource

Returns true if the respresened resource exists.

Specified by:

exists in class Resource

getFile

public File getFile()
             throws IOException

Description copied from class: Resource

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

Specified by:

getFile in class Resource

Throws:

IOException

getFollowLinks

public boolean getFollowLinks()

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: Resource

Returns an input stream to the resource

Specified by:

getInputStream in class Resource

Throws:

IOException

getName

public String getName()

Description copied from class: Resource

Returns the name of the resource

Specified by:

getName in class Resource

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

getURI

public URI getURI()

Description copied from class: Resource

Returns an URI representing the given resource

Overrides:

getURI 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isContainedIn

public boolean isContainedIn(Resource r)
                      throws MalformedURLException

Specified by:

isContainedIn in class Resource

Throws:

MalformedURLException

isDirectory

public boolean isDirectory()

Description copied from class: Resource

Returns true if the respresenetd resource is a container/directory. If the resource is not a file, resources ending with "/" are considered directories.

Specified by:

isDirectory in class Resource

lastModified

public long lastModified()

Description copied from class: Resource

Returns the last modified time

Specified by:

lastModified in class Resource

length

public long length()

Description copied from class: Resource

Return the length of the resource

Specified by:

length in class Resource

getAlias

public URI getAlias()

Overrides:

getAlias in class Resource

Returns:

The canonical Alias of this resource or null if none.

list

public String[] list()

Description copied from class: Resource

Returns a list of resource names contained in the given resource The resource names are not URL encoded.

Specified by:

list in class Resource

renameTo

public boolean renameTo(Resource dest)
                 throws SecurityException

Description copied from class: Resource

Rename the given resource

Specified by:

renameTo in class Resource

Throws:

SecurityException

setFollowLinks

public void setFollowLinks(boolean followLinks)