com.io7m.jvvfs

Class Filesystem

java.lang.Object

com.io7m.jvvfs.Filesystem

All Implemented Interfaces:

FilesystemType, FSCapabilityAllType, FSCapabilityCloseType, FSCapabilityCreateDirectoryType, FSCapabilityMountAnywhereType, FSCapabilityMountClasspathType, FSCapabilityMountDirectoryType, FSCapabilityMountSnapshotType, FSCapabilityReadType, FSCapabilityUnmountType, FSCapabilityUpdateTimeType

public final class Filesystem
extends Object
implements FilesystemType

The basic filesystem implementation.

This implementation supports loading of archives from a single directory, or from the classpath.

See Also:

makeWithArchiveDirectory(LogUsableType, PathReal), makeWithoutArchiveDirectory(LogUsableType)

Method Summary

Modifier and Type	Method and Description
void	close() Close the given filesystem.
void	createDirectory(PathVirtual path) Create a directory in the virtual filesystem at path.
boolean	exists(PathVirtual path)
long	getFileSize(PathVirtual path)
Calendar	getModificationTime(PathVirtual path)
Deque<com.io7m.jfunctional.Pair<PathReal,PathVirtual>>	getMountedArchives()
boolean	isDirectory(PathVirtual path)
boolean	isFile(PathVirtual path)
SortedSet<String>	listDirectory(PathVirtual path)
static FilesystemType	makeWithArchiveDirectory(com.io7m.jlog.LogUsableType log, PathReal archives) Construct a filesystem using archives as the location of the archive directory.
static FilesystemType	makeWithoutArchiveDirectory(com.io7m.jlog.LogUsableType log) Construct a filesystem without an archive directory.
void	mountArchive(String archive, PathVirtual mount) Mount the archive archive at mount.
void	mountArchiveFromAnywhere(File archive, PathVirtual mount) Mount the archive archive at mount.
void	mountClasspathArchive(Class<?> c, PathVirtual mount) Mount the archive containing class c at mount.
InputStream	openFile(PathVirtual path) Open the file at path.
void	unmount(PathVirtual mount) Unmounts the most recently mounted archive at mount.
void	updateModificationTime(PathVirtual path, Calendar t) Updates the modification time of the object at path to t.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

makeWithArchiveDirectory

public static FilesystemType makeWithArchiveDirectory(com.io7m.jlog.LogUsableType log,
                                                      PathReal archives)

Construct a filesystem using archives as the location of the archive directory.

Parameters:

log - The log interface

archives - The archive directory

Returns:

A new filesystem

makeWithoutArchiveDirectory

public static FilesystemType makeWithoutArchiveDirectory(com.io7m.jlog.LogUsableType log)

Construct a filesystem without an archive directory. A filesystem constructed in this manner may only access archives on the classpath.

Parameters:

log - The log interface

Returns:

A new filesystem

close

public void close()
           throws FilesystemError

Description copied from interface: FSCapabilityCloseType

Close the given filesystem. This:

• Unmounts and closes all archives
• Removes all virtual directories

Due to archives being closed, the state of any streams associated with files in the filesystem will become undefined.

Specified by:

close in interface FSCapabilityCloseType

Throws:

FilesystemError - If a filesystem error occurs.

createDirectory

public void createDirectory(PathVirtual path)
                     throws FilesystemError

Description copied from interface: FSCapabilityCreateDirectoryType

Create a directory in the virtual filesystem at path.

Specified by:

createDirectory in interface FSCapabilityCreateDirectoryType

Parameters:

path - The path.

Throws:

FilesystemError - If:

• An ancestor of path is not a directory.
• An I/O error occurs

exists

public boolean exists(PathVirtual path)
               throws FilesystemError

Specified by:

exists in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

true iff path exists.

Throws:

FilesystemError - If a filesystem error occurs.

getFileSize

public long getFileSize(PathVirtual path)
                 throws FilesystemError

Specified by:

getFileSize in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

The size of the file at path.

Throws:

FilesystemError - If:

• No object exists at path.
• The object at path is not a file
• An I/O error occurs

getModificationTime

public Calendar getModificationTime(PathVirtual path)
                             throws FilesystemError

Specified by:

getModificationTime in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

The modification time of the file or directory at path.

Throws:

FilesystemError - If:

• No object exists at r.
• An I/O error occurs.

getMountedArchives

public Deque<com.io7m.jfunctional.Pair<PathReal,PathVirtual>> getMountedArchives()

Specified by:

getMountedArchives in interface FSCapabilityMountSnapshotType

Returns:

A snapshot of the stack of mounted archives.

isDirectory

public boolean isDirectory(PathVirtual path)
                    throws FilesystemError

Specified by:

isDirectory in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

true iff path exists and is a directory.

Throws:

FilesystemError - If a filesystem error occurs.

isFile

public boolean isFile(PathVirtual path)
               throws FilesystemError

Specified by:

isFile in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

true iff path exists and is a file.

Throws:

FilesystemError - If a filesystem error occurs.

listDirectory

public SortedSet<String> listDirectory(PathVirtual path)
                                throws FilesystemError

Specified by:

listDirectory in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

A list of the contents of the directory at path.

Throws:

FilesystemError - If:

• No object exists at path.
• The object at path is not a directory
• An I/O error occurs

mountArchive

public void mountArchive(String archive,
                         PathVirtual mount)
                  throws FilesystemError

Description copied from interface: FSCapabilityMountDirectoryType

Mount the archive archive at mount. The path specified by mount is required to refer to an existing directory.

If the directory at mount exists but was not explicitly created with FSCapabilityCreateDirectoryType.createDirectory(PathVirtual), then the mountArchive function first calls FSCapabilityCreateDirectoryType.createDirectory(PathVirtual) to mark mount as explicitly created, and then attempts to mount the archive as normal.

Specified by:

mountArchive in interface FSCapabilityMountDirectoryType

Parameters:

archive - The archive to mount.

mount - The mount point for the archive.

Throws:

FilesystemError - If a filesystem error occurs.

mountArchiveFromAnywhere

public void mountArchiveFromAnywhere(File archive,
                                     PathVirtual mount)
                              throws FilesystemError

Description copied from interface: FSCapabilityMountAnywhereType

Mount the archive archive at mount. The path specified by mount is required to refer to an existing directory.

If the directory at mount exists but was not explicitly created with FSCapabilityCreateDirectoryType.createDirectory(PathVirtual), then the mountArchive function first calls FSCapabilityCreateDirectoryType.createDirectory(PathVirtual) to mark mount as explicitly created, and then attempts to mount the archive as normal.

Specified by:

mountArchiveFromAnywhere in interface FSCapabilityMountAnywhereType

Parameters:

archive - The archive to mount.

mount - The mount point for the archive.

Throws:

FilesystemError - If a filesystem error occurs.

mountClasspathArchive

public void mountClasspathArchive(Class<?> c,
                                  PathVirtual mount)
                           throws FilesystemError

Description copied from interface: FSCapabilityMountClasspathType

Mount the archive containing class c at mount. The path specified by mount is required to refer to an existing directory.

If the directory at mount exists but was not explicitly created with FSCapabilityCreateDirectoryType.createDirectory(PathVirtual), then the mountArchive function first calls FSCapabilityCreateDirectoryType.createDirectory(PathVirtual) to mark mount as explicitly created, and then attempts to mount the archive as normal.

Specified by:

mountClasspathArchive in interface FSCapabilityMountClasspathType

Parameters:

c - A class appearing in one of the archives on the classpath.

mount - The mount point for the archive.

Throws:

FilesystemError - If a filesystem error occurs.

openFile

public InputStream openFile(PathVirtual path)
                     throws FilesystemError

Description copied from interface: FSCapabilityReadType

Open the file at path.

Specified by:

openFile in interface FSCapabilityReadType

Parameters:

path - The path.

Returns:

An input stream.

Throws:

FilesystemError - If:

• No object exists at path.
• The object at path is not a file
• An I/O error occurs

unmount

public void unmount(PathVirtual mount)
             throws FilesystemError

Description copied from interface: FSCapabilityUnmountType

Unmounts the most recently mounted archive at mount. If another archive is mounted at a directory contained within the archive that would be unmounted, the operation fails.

Specified by:

unmount in interface FSCapabilityUnmountType

Parameters:

mount - The mount point.

Throws:

FilesystemError - If a filesystem error occurs.

updateModificationTime

public void updateModificationTime(PathVirtual path,
                                   Calendar t)
                            throws FilesystemError

Description copied from interface: FSCapabilityUpdateTimeType

Updates the modification time of the object at path to t.

Specified by:

updateModificationTime in interface FSCapabilityUpdateTimeType

Parameters:

path - The mount point.

t - The requested time.

Throws:

FilesystemError - If a filesystem error occurs