com.ibm.jaggr.core.impl.resource

Class FileResource

java.lang.Object

com.ibm.jaggr.core.resource.AbstractResourceBase

com.ibm.jaggr.core.impl.resource.FileResource

All Implemented Interfaces:

IResource

Direct Known Subclasses:

NIOFileResource

public class FileResource
extends AbstractResourceBase

Author:

chuckd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FileResource.VisitorResource Implementation of IResourceVisitor.Resource for files.

Constructor Summary

Constructors

Constructor and Description
FileResource(URI uri) Public constructor used by factory

Method Summary

Methods

Modifier and Type	Method and Description
FileResource.VisitorResource	asVisitorResource() This is a convenience method to return the current resource as a IResourceVisitor.Resource object.
boolean	exists() Returns true if the resource exists.
InputStream	getInputStream() Returns a InputStream object for the resource if the resource is not a directory/folder resource.
Reader	getReader() Returns a Reader object for the resource if the resource is not a directory/folder resource.
long	getSize() Returns the size of the content for this resource.
boolean	isFolder()
long	lastModified() Returns the last-modified date of the resource.
protected FileResource	newInstance(URI uri)
String	toString()
void	walkTree(IResourceVisitor visitor) Walks the folder tree rooted at the current resource, calling the IResourceVisitor.visitResource(IResourceVisitor.Resource, String) method for each resource or folder resource encountered.

Methods inherited from class com.ibm.jaggr.core.resource.AbstractResourceBase

getPath, getReferenceURI, getURI, resolve, setReferenceURI

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResource

public FileResource(URI uri)

Public constructor used by factory

Parameters:

uri - the resource URI

Method Detail

exists

public boolean exists()

Description copied from interface: IResource

Returns true if the resource exists.

Specified by:

exists in interface IResource

Overrides:

exists in class AbstractResourceBase

Returns:

True if the resource exists

lastModified

public long lastModified()

Description copied from interface: IResource

Returns the last-modified date of the resource.

Specified by:

lastModified in interface IResource

Overrides:

lastModified in class AbstractResourceBase

Returns:

The last-modified date

isFolder

public boolean isFolder()

Specified by:

isFolder in interface IResource

Overrides:

isFolder in class AbstractResourceBase

Returns:

true if the resource is a folder.

getSize

public long getSize()
             throws IOException

Description copied from interface: IResource

Returns the size of the content for this resource. Note that not all implementations are able to support this method. If the size cannot be provided, a IOException is thrown.

Specified by:

getSize in interface IResource

Overrides:

getSize in class AbstractResourceBase

Returns:

the size of the content for the resource

Throws:

IOException

getReader

public Reader getReader()
                 throws IOException

Description copied from interface: IResource

Returns a Reader object for the resource if the resource is not a directory/folder resource.

Returns:

The resource reader

Throws:

IOException - if the resource is a folder, or an I/O error occurred

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: IResource

Returns a InputStream object for the resource if the resource is not a directory/folder resource.

Returns:

The resource input stream

Throws:

IOException - if the resource is a folder, or an I/O error occurred

walkTree

public void walkTree(IResourceVisitor visitor)
              throws IOException

Description copied from interface: IResource

Walks the folder tree rooted at the current resource, calling the IResourceVisitor.visitResource(IResourceVisitor.Resource, String) method for each resource or folder resource encountered.

If this resource is not a folder, then visitor's IResourceVisitor.visitResource(IResourceVisitor.Resource, String) method is called once for this resource.

Specified by:

walkTree in interface IResource

Overrides:

walkTree in class AbstractResourceBase

Parameters:

visitor - An instance of IResourceVisitor

Throws:

IOException

asVisitorResource

public FileResource.VisitorResource asVisitorResource()

Description copied from interface: IResource

This is a convenience method to return the current resource as a IResourceVisitor.Resource object. This is useful for when you want to invoke a resource visitor for a resource that was obtained by means other than IResource.walkTree(IResourceVisitor). The resource must exist.

Note that calling IResourceVisitor.Resource.newResource(IAggregator) on objects returned from this method will generally throw UnsupportedOperationException

Specified by:

asVisitorResource in interface IResource

Overrides:

asVisitorResource in class AbstractResourceBase

Returns:

An IResourceVisitor.Resource for current resource

toString

public String toString()

Overrides:

toString in class Object

newInstance

protected FileResource newInstance(URI uri)