org.millscript.commons.vfs
Interface VVolume

All Known Implementing Classes:
AbstractMIMEVVolume, AbstractProtocolVVolume, AbstractVVolume, ChrootVolume, FtpVolume, HttpVolume, LocalVolume, ReadOnlyZipVolume, SimpleVolume

public interface VVolume

This interface describes the root of a virtual filesystem. From the root you can get the root folder.


Method Summary
 java.lang.StringBuffer appendBaseURI(java.lang.StringBuffer buffer)
          Appends the base URI of this volume to the specified string buffer.
 VFS getParentVFS()
          Returns the parent VFS, that which created this URI scheme handler.
 VFolder getRootVFolder()
          Returns the root VFolder for this virtual volume.
 java.net.URI getURI()
          Returns the URI for the root of this virtual filesystem volume.
 

Method Detail

appendBaseURI

java.lang.StringBuffer appendBaseURI(java.lang.StringBuffer buffer)
Appends the base URI of this volume to the specified string buffer. The base URI is considered to be the scheme, host and port of this volumes URI and possibly a few segments of a path.

Parameters:
buffer - the string buffer to append the base URI to
Returns:
the specified StringBuffer with this volumes base URI appended to it

getParentVFS

VFS getParentVFS()
Returns the parent VFS, that which created this URI scheme handler. The parent VFS is maintained through to each volume, so that we can use it for configuration.

Returns:

getRootVFolder

VFolder getRootVFolder()
Returns the root VFolder for this virtual volume.

Returns:
the VFolder for the root of this volume

getURI

java.net.URI getURI()
Returns the URI for the root of this virtual filesystem volume.

Returns:
a URI for this volume


Copyright © 2005-2007 Open World Ltd. All Rights Reserved.