org.jboss.virtual.plugins.context
Class DelegatingHandler

java.lang.Object
  org.jboss.virtual.plugins.context.AbstractVirtualFileHandler
      org.jboss.virtual.plugins.context.DelegatingHandler

All Implemented Interfaces:

Serializable, VirtualFileHandler

Direct Known Subclasses:

AssembledFileHandler

public class DelegatingHandler
extends AbstractVirtualFileHandler

A delegating VirtualFileHandler that allows for overriding the delegate parent and name. One usecase is a link which roots another VFSContext under a different parent and name.

Version:

$Revision:$

Author:

Scott.Stark@jboss.org

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jboss.virtual.plugins.context.AbstractVirtualFileHandler

cachedLastModified, log

Constructor Summary

DelegatingHandler(VFSContext context, VirtualFileHandler parent, String name, VirtualFileHandler delegate)
Create a DelegatingHandler

Method Summary

boolean	exists() Tests whether the underlying implementation file still exists.
VirtualFileHandler	getChild(String path) Get a child
List<VirtualFileHandler>	getChildren(boolean ignoreErrors) Get the children
long	getLastModified() When the file was last modified
long	getSize() Get the size
boolean	isHidden() Whether it is hidden
boolean	isLeaf() Whether it is a simple leaf of the VFS, i.e. whether it can contain other files
InputStream	openStream() Access the file contents.
URI	toURI() Get the VF URI (file://root/org/jboss/X.java)
URL	toURL() Get the VF URL (file://root/org/jboss/X.java)

Methods inherited from class org.jboss.virtual.plugins.context.AbstractVirtualFileHandler

checkClosed, checkParentExists, close, decrement, doClose, equals, getChildPathName, getChildVfsUrl, getName, getParent, getPathName, getVFSContext, getVfsUrl, getVirtualFile, hasBeenModified, hashCode, increment, setPathName, setVfsUrl, simpleFindChild, structuredFindChild, toString, toVfsUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingHandler

public DelegatingHandler(VFSContext context,
                         VirtualFileHandler parent,
                         String name,
                         VirtualFileHandler delegate)

Create a DelegatingHandler

Parameters:

context - - the context for the parent

parent - - the parent of the delegate in this VFS

name - - the name of the delegate in this VFS

delegate - - the handler delegate

Method Detail

getChild

public VirtualFileHandler getChild(String path)
                            throws IOException

Description copied from interface: VirtualFileHandler

Get a child

Parameters:

path - the path

Returns:

the child or null if not found

Throws:

IOException - for an error accessing the file system

getChildren

public List<VirtualFileHandler> getChildren(boolean ignoreErrors)
                                     throws IOException

Description copied from interface: VirtualFileHandler

Get the children

Parameters:

ignoreErrors - whether to ignore errors

Returns:

the children

Throws:

IOException - for an error accessing the file system

getLastModified

public long getLastModified()
                     throws IOException

Description copied from interface: VirtualFileHandler

When the file was last modified

Returns:

the last modified time

Throws:

IOException - for any problem accessing the virtual file system

getSize

public long getSize()
             throws IOException

Description copied from interface: VirtualFileHandler

Get the size

Returns:

the size

Throws:

IOException - for any problem accessing the virtual file system

isLeaf

public boolean isLeaf()
               throws IOException

Description copied from interface: VirtualFileHandler

Whether it is a simple leaf of the VFS, i.e. whether it can contain other files

Returns:

true if a simple file.

Throws:

IOException - for any problem accessing the virtual file system

exists

public boolean exists()
               throws IOException

Description copied from interface: VirtualFileHandler

Tests whether the underlying implementation file still exists.

Returns:

true if the file exists, false otherwise.

Throws:

IOException - - thrown on failure to detect existence.

isHidden

public boolean isHidden()
                 throws IOException

Description copied from interface: VirtualFileHandler

Whether it is hidden

Returns:

true if hidden.

Throws:

IOException - for any problem accessing the virtual file system

openStream

public InputStream openStream()
                       throws IOException

Description copied from interface: VirtualFileHandler

Access the file contents.

Returns:

An InputStream for the file contents.

Throws:

IOException - for any problem accessing the virtual file system

toURI

public URI toURI()
          throws URISyntaxException

Description copied from interface: VirtualFileHandler

Get the VF URI (file://root/org/jboss/X.java)

Returns:

the full URI to the VF in the VFS.

Throws:

URISyntaxException - for an error parsing the URI

toURL

public URL toURL()
          throws URISyntaxException,
                 MalformedURLException

Description copied from interface: VirtualFileHandler

Get the VF URL (file://root/org/jboss/X.java)

Specified by:

toURL in interface VirtualFileHandler

Overrides:

toURL in class AbstractVirtualFileHandler

Returns:

the full URL to the VF in the VFS.

Throws:

URISyntaxException - for an error parsing the URI

MalformedURLException - for any error