org.eclipse.jetty.util.resource
Class ResourceCollection

java.lang.Object
  extended by org.eclipse.jetty.util.resource.Resource
      extended by org.eclipse.jetty.util.resource.ResourceCollection
All Implemented Interfaces:
Serializable

public class ResourceCollection
extends Resource

A collection of resources (dirs). Allows webapps to have multiple (static) sources. The first resource in the collection is the main resource. If a resource is not found in the main resource, it looks it up in the order the resources were constructed.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.jetty.util.resource.Resource
__defaultUseCaches
 
Constructor Summary
ResourceCollection()
           
ResourceCollection(Resource[] resources)
           
ResourceCollection(String csvResources)
           
ResourceCollection(String[] resources)
           
 
Method Summary
 Resource addPath(String path)
          Returns the resource contained inside the current resource with the given name.
 void copyTo(File destination)
           
 boolean delete()
          Deletes the given resource
 boolean exists()
          Returns true if the respresened resource exists.
protected  Object findResource(String path)
           
 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
 OutputStream getOutputStream()
          Returns an output stream to the resource
 Resource[] getResources()
           
 URL getURL()
          Returns an URL representing the given resource
 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.
 void release()
          Release any resources held by the resource.
 boolean renameTo(Resource dest)
          Rename the given resource
 void setResources(Resource[] resources)
           
 void setResources(String csvResources)
           
 void setResources(String[] resources)
           
 void setResourcesAsCSV(String csvResources)
           
 String toString()
           
 
Methods inherited from class org.eclipse.jetty.util.resource.Resource
encode, finalize, getAlias, getAssociate, getDefaultUseCaches, getListHTML, getURI, isContainedIn, newClassPathResource, newClassPathResource, newResource, newResource, newResource, newResource, newSystemResource, setAssociate, setDefaultUseCaches, writeTo
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceCollection

public ResourceCollection()

ResourceCollection

public ResourceCollection(Resource[] resources)

ResourceCollection

public ResourceCollection(String[] resources)

ResourceCollection

public ResourceCollection(String csvResources)
Method Detail

setResources

public void setResources(Resource[] resources)
Parameters:
resources - Resource array

setResources

public void setResources(String[] resources)
Parameters:
resources - String array

setResources

public void setResources(String csvResources)
Parameters:
csvResources - Comma separated values

setResourcesAsCSV

public void setResourcesAsCSV(String csvResources)
Parameters:
csvResources - Comma separated values

getResources

public Resource[] getResources()
Returns:
the resource array

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
Returns:
The contained resource (found first) in the collection of resources
Throws:
IOException
MalformedURLException

findResource

protected Object findResource(String path)
                       throws IOException,
                              MalformedURLException
Parameters:
path -
Returns:
the resource(file) if found, returns a list of resource dirs if its a dir, else null.
Throws:
IOException
MalformedURLException

delete

public boolean delete()
               throws SecurityException
Description copied from class: Resource
Deletes the given resource

Specified by:
delete in class Resource
Throws:
SecurityException

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

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

getOutputStream

public OutputStream getOutputStream()
                             throws IOException,
                                    SecurityException
Description copied from class: Resource
Returns an output stream to the resource

Specified by:
getOutputStream in class Resource
Throws:
IOException
SecurityException

getURL

public URL getURL()
Description copied from class: Resource
Returns an URL representing the given resource

Specified by:
getURL in class Resource

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

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
Returns:
The list of resource names(merged) contained in the collection of resources.

release

public void release()
Description copied from class: Resource
Release any resources held by the resource.

Specified by:
release 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

copyTo

public void copyTo(File destination)
            throws IOException
Overrides:
copyTo in class Resource
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object
Returns:
the list of resources separated by a path separator

isContainedIn

public boolean isContainedIn(Resource r)
                      throws MalformedURLException
Specified by:
isContainedIn in class Resource
Throws:
MalformedURLException


Copyright © 1995-2009 Mort Bay Consulting. All Rights Reserved.