com.io7m.jvvfs

Interface FSCapabilityReadType

All Known Subinterfaces:

FilesystemType, FSCapabilityAllType

All Known Implementing Classes:

Filesystem

public interface FSCapabilityReadType

The interface exposed by filesystem implementations that have the capability to read from mounted archives.

Method Summary

Modifier and Type	Method and Description
boolean	exists(PathVirtual path)
long	getFileSize(PathVirtual path)
Calendar	getModificationTime(PathVirtual path)
boolean	isDirectory(PathVirtual path)
boolean	isFile(PathVirtual path)
SortedSet<String>	listDirectory(PathVirtual path)
InputStream	openFile(PathVirtual path) Open the file at path.

Method Detail

exists

boolean exists(PathVirtual path)
        throws FilesystemError

Parameters:

path - The path.

Returns:

true iff path exists.

Throws:

FilesystemError - If a filesystem error occurs.

getFileSize

long getFileSize(PathVirtual path)
          throws FilesystemError

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

Calendar getModificationTime(PathVirtual path)
                      throws FilesystemError

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.

isDirectory

boolean isDirectory(PathVirtual path)
             throws FilesystemError

Parameters:

path - The path.

Returns:

true iff path exists and is a directory.

Throws:

FilesystemError - If a filesystem error occurs.

isFile

boolean isFile(PathVirtual path)
        throws FilesystemError

Parameters:

path - The path.

Returns:

true iff path exists and is a file.

Throws:

FilesystemError - If a filesystem error occurs.

listDirectory

SortedSet<String> listDirectory(PathVirtual path)
                         throws FilesystemError

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

openFile

InputStream openFile(PathVirtual path)
              throws FilesystemError

Open the file at path.

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