fixParents

private void fixParents(String entryName)

split

private String[] split(String entryName)

Splits the given entry name in a parent entry name and a base name.

Parameters:

entryName - The name of the entry which's parent entry name and base name are to be returned.

Returns:

The split array, which will hold at least two strings:

• Index 0 holds the parent entry name. If entryName is empty or equals SEPARATOR, this is null. Otherwise, this contains the parent name of the entry and always ends with an SEPARATOR.
• Index 1 holds the base name. If entryName is empty or equals SEPARATOR, this is an empty string. Otherwise, this contains the base name of the entry and never contains an SEPARATOR.

Throws:

NullPointerException - If entryName is null.

split

static String[] split(String entryName,
                      String[] result)

isReadOnly

boolean isReadOnly()

Indicates whether this file system is read only or not. The default is false.

isTouched

boolean isTouched()

Indicates whether this file system has been modified since its time of creation or the last call to resetTouched().

touch

private void touch()
            throws IOException

Ensures that the controller's data structures required to output entries are properly initialized and marks this virtual archive file system as touched.

Throws:

ArchiveReadOnlyExceptionn - If this virtual archive file system is read only.

IOException - If setting up the required data structures in the controller fails for some reason.

getArchiveEntries

Enumeration getArchiveEntries()

Returns an enumeration of all ArchiveEntry instances in this file system.

getRoot

ArchiveEntry getRoot()

Returns the virtual root directory of this file system. This archive entry always exists. It's name may depend on the archive type. It's last modification time is guaranteed to be non-negative, so it's not a ghost directory!

isRoot

static boolean isRoot(String entryName)

Returns true iff the given entry name refers to the virtual root directory within this controller.

get

ArchiveEntry get(String entryName)

Looks up the specified entry in the file system and returns it or null if not existent.

link

ArchiveFileSystem.Delta link(String entryName,
                             boolean createParents)
                       throws ArchiveFileSystem.ArchiveFileSystemException

Equivalent to link(entryName, createParents, null).

Throws:

ArchiveFileSystem.ArchiveFileSystemException

link

ArchiveFileSystem.Delta link(String entryName,
                             boolean createParents,
                             ArchiveEntry template)
                       throws ArchiveFileSystem.ArchiveFileSystemException

Begins a "create and link entry" transaction to ensure that either a new entry for the given entryName will be created or an existing entry is replaced within this virtual archive file system.

This is the first step of a two-step process to create an archive entry and link it into this virtual archive file system. To commit the transaction, call ArchiveFileSystem.LinkDelta.commit() on the returned object after you have successfully conducted the operations which compose the transaction.

Upon a commit operation, the last modification time of the newly created and linked entries will be set to the system's current time at the moment the transaction has begun and the file system will be marked as touched at the moment the transaction has been committed.

Note that there is no rollback operation: After this method returns, nothing in the virtual file system has changed yet and all information required to commit the transaction is contained in the returned object. Hence, if the operations which compose the transaction fails, the returned object may be safely collected by the garbage collector,

Parameters:

entryName - The relative path name of the entry to create or replace.

createParents - If true, any non-existing parent directory will be created in this file system with its last modification time set to the system's current time.

template - If not null, then the newly created or replaced entry shall inherit as much properties from this instance as possible (with the exception of the name). This is typically used for archive copy operations and requires some support by the archive driver.

Returns:

A transaction object. You must call its ArchiveFileSystem.LinkDelta.commit() method in order to commit link the newly created entry into this virtual archive file system.

Throws:

ArchiveReadOnlyExceptionn - If this virtual archive file system is read only.

ArchiveFileSystem.ArchiveFileSystemException - If one of the following is true:

• entryName contains characters which are not supported by the archive file.
• The entry name indicates a directory (trailing /) and its entry does already exist within this file system.
• The entry is a file or directory and does already exist as the respective other type within this file system.
• The parent directory does not exist and createParents is false.
• One of the entry's parents denotes a file.

createArchiveEntry

private ArchiveEntry createArchiveEntry(String entryName,
                                        ArchiveEntry blueprint)
                                 throws CharConversionException

Creates an archive entry which is going to be linked into this virtual archive file system in the near future. The returned entry has properly initialized meta data, but is otherwise left as created by the archive driver.

Parameters:

entryName - The path name of the entry to create or replace. This must be a relative path name.

blueprint - If not null, then the newly created entry shall inherit as much attributes from this object as possible (with the exception of the name). This is typically used for archive copy operations and requires some support by the archive driver.

Returns:

An ArchiveEntry created by the archive driver and properly initialized with meta data.

Throws:

CharConversionException - If entryName contains characters which are not supported by the archive file.

createArchiveEntry

private ArchiveEntry createArchiveEntry(String entryName)

Like createArchiveEntry(java.lang.String, de.schlichtherle.io.archive.spi.ArchiveEntry), but throws an AssertionError instead of CharConversionException.

Throws:

AssertionError - If a CharConversionException occurs.

unlink

private void unlink(String entryName)
             throws IOException

If this method returns, the entry identified by the given entryName has been successfully deleted from the virtual archive file system. If the entry is a directory, it must be empty for successful deletion.

Throws:

ArchiveReadOnlyExceptionn - If the virtual archive file system is read only.

ArchiveIllegalOperationException - If the operation failed for any other reason.

IOException

exists

boolean exists(String entryName)

isFile

boolean isFile(String entryName)

isDirectory

boolean isDirectory(String entryName)

getOpenIcon

Icon getOpenIcon(String entryName)

getClosedIcon

Icon getClosedIcon(String entryName)

canWrite

boolean canWrite(String entryName)

setReadOnly

boolean setReadOnly(String entryName)

length

long length(String entryName)

lastModified

long lastModified(String entryName)

setLastModified

boolean setLastModified(String entryName,
                        long time)
                  throws IOException

Throws:

IOException

list

String[] list(String entryName)

list

String[] list(String entryName,
              FilenameFilter filenameFilter,
              File dir)

listFiles

File[] listFiles(String entryName,
                 FilenameFilter filenameFilter,
                 File dir,
                 FileFactory factory)

listFiles

File[] listFiles(String entryName,
                 FileFilter fileFilter,
                 File dir,
                 FileFactory factory)

mkdir

void mkdir(String entryName,
           boolean createParents)
     throws IOException

Throws:

IOException

delete

void delete(String entryName)
      throws IOException

Throws:

IOException