Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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:
  java.io.Serializable, StructuredVirtualFileHandler, VirtualFileHandler

    public class SynthenticDirEntryHandler

extends AbstractURLHandler
implements StructuredVirtualFileHandler

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, vfsUrl`

Constructor Summary
`SynthenticDirEntryHandler(VFSContext context, VirtualFileHandler parent, java.lang.String entryName, long lastModified, java.net.URL url)` Create a new SynthenticDirEntryHandler.

Method Summary
`void` | `addChild(VirtualFileHandler child)` Add a child to an entry
`VirtualFileHandler` | `createChildHandler(java.lang.String name)` Create a child handler for the given name.
`boolean` | `exists()` TODO: removing the entry/jar that resulted in this needs to be detected.
`VirtualFileHandler` | `findChild(java.lang.String path)` Find a child
`java.util.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.
`java.io.InputStream` | `openStream()` Access the file contents.

Methods inherited from class org.jboss.virtual.plugins.context.AbstractURLHandler
`getURL, initCacheLastModified, toURI, toURL`

Methods inherited from class org.jboss.virtual.plugins.context.AbstractVirtualFileHandler
`checkClosed, close, decrement, doClose, equals, getName, getParent, getPathName, getVFSContext, getVirtualFile, hasBeenModified, hashCode, increment, setPathName, simpleFindChild, structuredFindChild, toString, 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,
                                     java.lang.String entryName,
                                     long lastModified,
                                     java.net.URL url)
                              throws java.io.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:
    `java.io.IOException` - for an error accessing the file system
    `java.lang.IllegalArgumentException` - for a null context, url, jar or entry

Method Detail

### addChild

    public void addChild(VirtualFileHandler child)

  Add a child to an entry

  Parameters:
    `child` -

### getLastModified

    public long getLastModified()

  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

### 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 java.io.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:
    `java.io.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.

### openStream

    public java.io.InputStream openStream()
                                   throws java.io.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:
    `java.io.IOException` - for any problem accessing the virtual file system

### getChildren

    public java.util.List<VirtualFileHandler> getChildren(boolean ignoreErrors)
                                                   throws java.io.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:
    `java.io.IOException` - for an error accessing the file system

### findChild

    public VirtualFileHandler findChild(java.lang.String path)
                                 throws java.io.IOException

  Description copied from interface: `VirtualFileHandler`
  Find a child

  Specified by:
    `findChild` in interface `VirtualFileHandler`
  Parameters:
    `path` - the path
  Returns:
    the child
  Throws:
    `java.io.IOException` - for an error accessing the file system (or the child doesn't exist)

### createChildHandler

    public VirtualFileHandler createChildHandler(java.lang.String name)
                                          throws java.io.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:
    `java.io.IOException` - - thrown if there are no children or the name does not match a child

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD