FileSystem (lif-fs Documentation)

All Known Implementing Classes:

Base64FileSystem, Chroot, FilterFileSystem, FlatFileSystem, FloppyDisk, FtpConnection, HardDisk, JarFile, Mirror, NoopFileSystem, PersistentFileSystem, RamDisk, ReadOnlyFileSystem, ReadZipFile, TempFolder, ThrottledFileSystem, WriteZipFile
```
public interface FileSystem
```
Abstraction of elementary read and write operations over a file system.

Author:

Sylvain Hallé

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class FileSystem.OpenState
Enumeration representing the three possible states of a file system.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FileSystem.OpenState` Enumeration representing the three possible states of a file system.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`chdir(java.lang.String path)` Changes the current directory.
`void`	`close()` Stops the interaction with the file system.
`void`	`delete(java.lang.String path)` Deletes a directory and all its contents.
`long`	`getSize(java.lang.String path)` Gets the size of a file.
`boolean`	`isDirectory(java.lang.String path)` Determines if the resource pointed to by a given path corresponds to a directory.
`boolean`	`isFile(java.lang.String path)` Determines if the resource pointed to by a given path corresponds to a file.
`java.util.List<java.lang.String>`	`ls()` Lists all the files and folders in the current directory.
`java.util.List<java.lang.String>`	`ls(java.lang.String path)` Lists all the files and folders in a given directory.
`void`	`mkdir(java.lang.String path)` Creates a directory if it does not exist.
`void`	`open()` Starts the interaction with the file system.
`void`	`popd()` Changes the current directory to the one before the last call to `chdir(String)` or `pushd(String)`.
`void`	`pushd(java.lang.String path)`
`java.lang.String`	`pwd()` Retrieves the current working directory, relative to the root of the file system.
`java.io.InputStream`	`readFrom(java.lang.String filename)` Reads data from a file.
`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.

- Method Detail
  - open
```
void open()
   throws FileSystemException
```
    Starts the interaction with the file system. All operations invoked on a file system will throw a FileSystemException if called before this method.
    
    Throws:
    
    FileSystemException - Thrown if the interaction with the file system cannot be started
  - ls
```
java.util.List<java.lang.String> ls()
                             throws FileSystemException
```
    Lists all the files and folders in the current directory.
    
    Returns:
    
    The list of files and folders
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - ls
```
java.util.List<java.lang.String> ls(java.lang.String path)
                             throws FileSystemException
```
    Lists all the files and folders in a given directory.
    
    Parameters:
    
    path - The path from which to list files
    
    Returns:
    
    The list of files and folders
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - isDirectory
```
boolean isDirectory(java.lang.String path)
             throws FileSystemException
```
    Determines if the resource pointed to by a given path corresponds to a directory.
    
    Parameters:
    
    path - The path
    
    Returns:
    
    true if the resource exists and is a directory, false otherwise
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - isFile
```
boolean isFile(java.lang.String path)
        throws FileSystemException
```
    Determines if the resource pointed to by a given path corresponds to a file.
    
    Parameters:
    
    path - The path
    
    Returns:
    
    true if the resource exists and is a file, false otherwise
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - getSize
```
long getSize(java.lang.String path)
      throws FileSystemException
```
    Gets the size of a file.
    
    Parameters:
    
    path - The path corresponding to the file
    
    Returns:
    
    The size in bytes
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - writeTo
```
java.io.OutputStream writeTo(java.lang.String filename)
                      throws FileSystemException
```
    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.
    
    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
  - readFrom
```
java.io.InputStream readFrom(java.lang.String filename)
                      throws FileSystemException
```
    Reads data from a file. The method provides an InputStream from which data can be read. Consumers of this input stream have the responsibility to close the stream after usage.
    
    Parameters:
    
    filename - The name of the file to which data is to be written
    
    Returns:
    
    A print 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
  - chdir
```
void chdir(java.lang.String path)
    throws FileSystemException
```
    Changes the current directory.
    
    Parameters:
    
    path - The directory to change to. The string can contain a path relative to the current directory.
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - pushd
```
void pushd(java.lang.String path)
    throws FileSystemException
```
    Parameters:
    
    path - The directory to change to. The string can contain a path relative to the current directory.
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - popd
```
void popd()
   throws FileSystemException
```
    Changes the current directory to the one before the last call to chdir(String) or pushd(String).
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - mkdir
```
void mkdir(java.lang.String path)
    throws FileSystemException
```
    Creates a directory if it does not exist.
    
    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
```
void rmdir(java.lang.String path)
    throws FileSystemException
```
    Deletes a directory and all its contents.
    
    Parameters:
    
    path - The directory to delete
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - delete
```
void delete(java.lang.String path)
     throws FileSystemException
```
    Deletes a directory and all its contents.
    
    Parameters:
    
    path - The directory to delete
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - pwd
```
java.lang.String pwd()
              throws FileSystemException
```
    Retrieves the current working directory, relative to the root of the file system.
    
    Returns:
    
    A string representing the current working directory
    
    Throws:
    
    FileSystemException - Thrown if the operation could not be performed for some reason
  - close
```
void close()
    throws FileSystemException
```
    Stops the interaction with the file system. All operations invoked on a file system will throw a FileSystemException if called after this method.
    
    Throws:
    
    FileSystemException - Thrown if an error occurred while stopping the interaction with the file system

Interface FileSystem

Nested Class Summary

Method Summary

Method Detail

open

ls

ls

isDirectory

isFile

getSize

writeTo

readFrom

chdir

pushd

popd

mkdir

rmdir

delete

pwd

close