ca.uqac.lif.fs

Class ReadOnlyFileSystem

java.lang.Object

ca.uqac.lif.fs.FilterFileSystem

ca.uqac.lif.fs.ReadOnlyFileSystem

All Implemented Interfaces:

FileSystem

public class ReadOnlyFileSystem
extends FilterFileSystem

A file system that disables all write operations of another file system, rendering it read-only.

Author:

Sylvain Hallé

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uqac.lif.fs.FileSystem

FileSystem.OpenState

Field Summary

Fields inherited from class ca.uqac.lif.fs.FilterFileSystem

m_fs

Constructor Summary

Constructors

Constructor and Description
ReadOnlyFileSystem(FileSystem fs) Creates a new read-only file system.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String path) Deletes a directory and all its contents.
void	mkdir(java.lang.String path) Creates a directory if it does not exist.
void	rmdir(java.lang.String path) Deletes a directory and all its contents.
java.io.OutputStream	writeTo(java.lang.String filename) Writes data to a file.

Methods inherited from class ca.uqac.lif.fs.FilterFileSystem

chdir, close, getSize, isDirectory, isFile, ls, ls, open, popd, pushd, pwd, readFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyFileSystem

public ReadOnlyFileSystem(FileSystem fs)

Creates a new read-only file system.

Parameters:

fs - The underlying file system to regulate access to

Method Detail

mkdir

public void mkdir(java.lang.String path)
           throws FileSystemException

Description copied from interface: FileSystem

Creates a directory if it does not exist.

Specified by:

mkdir in interface FileSystem

Overrides:

mkdir in class FilterFileSystem

Parameters:

path - The directory to create. The string can contain a path relative to the current directory.

Throws:

FileSystemException - Thrown if the operation could not be performed for some reason

rmdir

public void rmdir(java.lang.String path)
           throws FileSystemException

Description copied from interface: FileSystem

Deletes a directory and all its contents.

Specified by:

rmdir in interface FileSystem

Overrides:

rmdir in class FilterFileSystem

Parameters:

path - The directory to delete

Throws:

FileSystemException - Thrown if the operation could not be performed for some reason

delete

public void delete(java.lang.String path)
            throws FileSystemException

Description copied from interface: FileSystem

Deletes a directory and all its contents.

Specified by:

delete in interface FileSystem

Overrides:

delete in class FilterFileSystem

Parameters:

path - The directory to delete

Throws:

FileSystemException - Thrown if the operation could not be performed for some reason

writeTo

public java.io.OutputStream writeTo(java.lang.String filename)
                             throws FileSystemException

Description copied from interface: FileSystem

Writes data to a file. The method provides an OutputStream to which data can be printed. The data is guaranteed to be committed to the file only when the print stream is closed. Whether data is written before that moment depends on the actual file system implementation.

Specified by:

writeTo in interface FileSystem

Overrides:

writeTo in class FilterFileSystem

Parameters:

filename - The name of the file to which data is to be written

Returns:

An output stream open on the file. If the method successfully returns, it guarantees that this stream is not null

Throws:

FileSystemException - Thrown if the operation could not be performed for some reason