org.jboss.virtual.plugins.context.jar
Class SynthenticDirEntryHandler

java.lang.Object
  org.jboss.virtual.plugins.context.AbstractVirtualFileHandler
      org.jboss.virtual.plugins.context.AbstractURLHandler
          org.jboss.virtual.plugins.context.jar.SynthenticDirEntryHandler

All Implemented Interfaces:

Serializable, HierarchyVirtualFileHandler, StructuredVirtualFileHandler, VirtualFileHandler

public class SynthenticDirEntryHandler
extends AbstractURLHandler
implements StructuredVirtualFileHandler, HierarchyVirtualFileHandler

SynthenticDirEntryHandler represents non-existent directory jar entry.

Version:

$Revision: 1.1 $

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

SynthenticDirEntryHandler(VFSContext context, VirtualFileHandler parent, String entryName, long lastModified, URL url)
Create a new SynthenticDirEntryHandler.

Method Summary

void	addChild(VirtualFileHandler child) Add a child to an entry
VirtualFileHandler	createChildHandler(String name) Create a child handler for the given name.
boolean	delete(int gracePeriod) Delete the file represented by this handler.
boolean	exists() TODO: removing the entry/jar that resulted in this needs to be detected.
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
protected void	initCacheLastModified()
protected void	internalReplaceChild(VirtualFileHandler original, VirtualFileHandler replacement) Replace original child with unpacked replacement.
boolean	isHidden() Whether it is hidden
boolean	isLeaf() Whether it is a simple leaf of the VFS, i.e.
boolean	isNested() Are we nested in some archive.
InputStream	openStream() Access the file contents.
boolean	removeChild(String name) Remove a child

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

getURL, openConnection, openConnection, toURI, toURL

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

checkClosed, checkParentExists, cleanup, close, decrement, doClose, equals, getChildPathName, getChildVfsUrl, getLocalPathName, getLocalVFSContext, getName, getParent, getPathName, getRealURL, getReferences, getVFSContext, getVfsUrl, getVirtualFile, hasBeenModified, hashCode, increment, isArchive, isTemporary, replaceChild, setPathName, setVfsUrl, simpleFindChild, structuredFindChild, toInternalVfsUrl, toString, toStringLocal, toVfsUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

SynthenticDirEntryHandler

public SynthenticDirEntryHandler(VFSContext context,
                                 VirtualFileHandler parent,
                                 String entryName,
                                 long lastModified,
                                 URL url)
                          throws IOException

Create a new SynthenticDirEntryHandler.

Parameters:

context - the context

parent - the parent

entryName - - the simple name for the dir

lastModified - the timestamp for the dir

url - the full url

Throws:

IOException - for an error accessing the file system

IllegalArgumentException - for a null context, url, jar or entry

Method Detail

initCacheLastModified

protected void initCacheLastModified()

Overrides:

initCacheLastModified in class AbstractURLHandler

addChild

public void addChild(VirtualFileHandler child)

Add a child to an entry

Specified by:

addChild in interface HierarchyVirtualFileHandler

Parameters:

child - the child file handler

getLastModified

public long getLastModified()
                     throws IOException

Description copied from interface: VirtualFileHandler

When the file was last modified

Specified by:

getLastModified in interface VirtualFileHandler

Overrides:

getLastModified in class AbstractURLHandler

Returns:

the last modified time

Throws:

IOException - for any problem accessing the virtual file system

getSize

public long getSize()

Description copied from interface: VirtualFileHandler

Get the size

Specified by:

getSize in interface VirtualFileHandler

Overrides:

getSize in class AbstractURLHandler

Returns:

the size

exists

public boolean exists()
               throws IOException

TODO: removing the entry/jar that resulted in this needs to be detected.

Specified by:

exists in interface VirtualFileHandler

Overrides:

exists in class AbstractURLHandler

Returns:

true if the file exists, false otherwise.

Throws:

IOException - - thrown on failure to detect existence.

See Also:

URLConnection.getLastModified(), org.jboss.test.virtual.test.URLExistsUnitTestCase

isLeaf

public boolean isLeaf()

Description copied from interface: VirtualFileHandler

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

Specified by:

isLeaf in interface VirtualFileHandler

Returns:

true if a simple file.

isHidden

public boolean isHidden()

Description copied from interface: VirtualFileHandler

Whether it is hidden

Specified by:

isHidden in interface VirtualFileHandler

Overrides:

isHidden in class AbstractURLHandler

Returns:

true if hidden.

isNested

public boolean isNested()
                 throws IOException

Description copied from interface: VirtualFileHandler

Are we nested in some archive.

Specified by:

isNested in interface VirtualFileHandler

Returns:

true if this is archive entry

Throws:

IOException - for any error

delete

public boolean delete(int gracePeriod)

Description copied from class: AbstractVirtualFileHandler

Delete the file represented by this handler. File deletion is comprised of two parts:

1. physical file deletion - performed by this method or its override
2. removal of any child references from the parent - performed by VirtualFileHandler.removeChild(String) of the parent

This method doesn't do any physical file removal because it has no concept of underlying physical file. An implementation that does physical file removal should override this method and call super.delete() at the end.

Specified by:

delete in interface VirtualFileHandler

Overrides:

delete in class AbstractVirtualFileHandler

Parameters:

gracePeriod - max time to wait for any locks

Returns:

true if file was deleted, false otherwise

openStream

public InputStream openStream()
                       throws IOException

Description copied from interface: VirtualFileHandler

Access the file contents.

Specified by:

openStream in interface VirtualFileHandler

Overrides:

openStream in class AbstractURLHandler

Returns:

An InputStream for the file contents.

Throws:

IOException - for any problem accessing the virtual file system

getChildren

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

Description copied from interface: VirtualFileHandler

Get the children

Specified by:

getChildren in interface VirtualFileHandler

Parameters:

ignoreErrors - whether to ignore errors

Returns:

the children

Throws:

IOException - for an error accessing the file system

createChildHandler

public VirtualFileHandler createChildHandler(String name)
                                      throws IOException

Create a child handler for the given name. This looks to the entryMap for an existing child.

Specified by:

createChildHandler in interface StructuredVirtualFileHandler

Parameters:

name - - the simple name of an immeadiate child.

Returns:

the VirtualFileHandler previously added via addChild.

Throws:

IOException - - thrown if there are no children or the name does not match a child

getChild

public VirtualFileHandler getChild(String path)
                            throws IOException

Description copied from interface: VirtualFileHandler

Get a child

Specified by:

getChild in interface VirtualFileHandler

Parameters:

path - the path

Returns:

the child or null if not found

Throws:

IOException - for an error accessing the file system

removeChild

public boolean removeChild(String name)
                    throws IOException

Description copied from interface: VirtualFileHandler

Remove a child

Specified by:

removeChild in interface VirtualFileHandler

Parameters:

name - child name

Returns:

true if child was removed, false otherwise

Throws:

IOException - if an error occurs

internalReplaceChild

protected void internalReplaceChild(VirtualFileHandler original,
                                    VirtualFileHandler replacement)

Description copied from class: AbstractVirtualFileHandler

Replace original child with unpacked replacement.

Overrides:

internalReplaceChild in class AbstractVirtualFileHandler

Parameters:

original - the original

replacement - the replacement