Package org.eclipse.jetty.util.resource

Class EmptyResource

java.lang.Object

org.eclipse.jetty.util.resource.Resource

org.eclipse.jetty.util.resource.EmptyResource

All Implemented Interfaces:

Closeable, AutoCloseable, ResourceFactory

public class EmptyResource
extends Resource

EmptyResource Represents a resource that does does not refer to any file, url, jar etc.

Field Summary

Fields

Modifier and Type	Field	Description
static final Resource	INSTANCE

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

__defaultUseCaches

Method Summary

Modifier and Type	Method	Description
Resource	addPath(String path)	Returns the resource contained inside the current resource with the given name, which may or may not exist.
void	close()	Release any temporary resources held by the resource.
boolean	delete()	Deletes the given resource
boolean	exists()
File	getFile()	File representing the given resource.
InputStream	getInputStream()	Input stream to the resource
String	getName()	The name of the resource.
ReadableByteChannel	getReadableByteChannel()	Readable ByteChannel for the resource.
URI	getURI()	URI representing the resource.
boolean	isContainedIn(Resource r)
boolean	isDirectory()
long	lastModified()	Time resource was last modified.
long	length()	Length of the resource.
String[]	list()	list of resource names contained in the given resource.
boolean	renameTo(Resource dest)	Rename the given resource

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

copyTo, fromList, fromList, getAlias, getAllResources, getAssociate, getDefaultUseCaches, getListHTML, getResource, getWeakETag, getWeakETag, isAlias, isContainedIn, isSame, newClassPathResource, newClassPathResource, newResource, newResource, newResource, newResource, newResource, newResource, newSystemResource, resolveAlias, setAssociate, setDefaultUseCaches, toURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final Resource INSTANCE

Method Details

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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Resource

exists

public boolean exists()

Specified by:

exists in class Resource

Returns:

true if the represented resource exists.

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in class Resource

Returns:

true if the represented resource is a container/directory.

lastModified

public long lastModified()

Description copied from class: Resource

Time resource was last modified.

Specified by:

lastModified in class Resource

Returns:

the last modified time as milliseconds since unix epoch

length

public long length()

Description copied from class: Resource

Length of the resource.

Specified by:

length in class Resource

Returns:

the length of the resource

getURI

public URI getURI()

Description copied from class: Resource

URI representing the resource.

Specified by:

getURI in class Resource

Returns:

an URI representing the given resource

getFile

public File getFile()
             throws IOException

Description copied from class: Resource

File representing the given resource.

Specified by:

getFile in class Resource

Returns:

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

Throws:

IOException - if unable to get the resource due to permissions

getName

public String getName()

Description copied from class: Resource

The name of the resource.

Specified by:

getName in class Resource

Returns:

the name of the resource

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: Resource

Input stream to the resource

Specified by:

getInputStream in class Resource

Returns:

an input stream to the resource

Throws:

IOException - if unable to open the input stream

getReadableByteChannel

public ReadableByteChannel getReadableByteChannel()
                                           throws IOException

Description copied from class: Resource

Readable ByteChannel for the resource.

Specified by:

getReadableByteChannel in class Resource

Returns:

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

Throws:

IOException - if unable to open the readable bytechannel for the resource.

delete

public boolean delete()
               throws SecurityException

Description copied from class: Resource

Deletes the given resource

Specified by:

delete in class Resource

Returns:

true if resource was found and successfully deleted, false if resource didn't exist or was unable to be deleted.

Throws:

SecurityException - if unable to delete due to permissions

renameTo

public boolean renameTo(Resource dest)
                 throws SecurityException

Description copied from class: Resource

Rename the given resource

Specified by:

renameTo in class Resource

Parameters:

dest - the destination name for the resource

Returns:

true if the resource was renamed, false if the resource didn't exist or was unable to be renamed.

Throws:

SecurityException - if unable to rename due to permissions

list

public String[] list()

Description copied from class: Resource

list of resource names contained in the given resource. Ordering is unspecified, so callers may wish to sort the return value to ensure deterministic behavior.

Specified by:

list in class Resource

Returns:

a list of resource names contained in the given resource, or null. Note: The resource names are not URL encoded.

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, which may or may not exist.

Specified by:

addPath in class Resource

Parameters:

path - The path segment to add, which is not encoded. The path may be non canonical, but if so then the resulting Resource will return true from Resource.isAlias().

Returns:

the Resource for the resolved path within this Resource, never null

Throws:

IOException - if unable to resolve the path

MalformedURLException - if the resolution of the path fails because the input path parameter is malformed, or a relative path attempts to access above the root resource.