com.adaptris.fs

Interface FsWorker

All Known Implementing Classes:

AppendingFsWorker, NioWorker, OverwriteIfExistsWorker, StandardWorker

public interface FsWorker

Defines basic file system operations. Implementations may be based on java.io, java.nio, etc., etc. This interface is currently envisaged for local file system use only.

Method Summary

Modifier and Type	Method and Description
static java.io.File	checkExists(java.io.File file) Throw an exception if the file does not exist.
static java.io.File	checkNonExistent(java.io.File file) Throw an exception if the file exists.
static java.io.File	checkReadable(java.io.File file) Throw an exception if the file is not readable
static java.io.File	checkWriteable(java.io.File file) Throw an exception if the file is not readable or writeable
default void	delete(java.io.File file) Deletes the specified file.
byte[]	get(java.io.File file) Gets the contents of the specified File.
static java.io.File	isDirectory(java.io.File file) Throw an exception if the file is not a directory
static java.io.File	isFile(java.io.File file) Throw an exception if the file is not a plain file.
default boolean	isWriteableDir(java.io.File dir) Returns true if the passed File is a writeable directory, otherwise false.
default java.io.File[]	listFiles(java.io.File dir) Returns an array of Files in directory dir.
default java.io.File[]	listFiles(java.io.File dir, java.io.FileFilter filter) Returns an array of Files in directory dir that match the passed filter.
void	put(byte[] data, java.io.File file) Writes data to the specified file.
default void	rename(java.io.File oldFile, java.io.File newFile) Renames oldfile to newName.

Method Detail

listFiles

default java.io.File[] listFiles(java.io.File dir)
                          throws FsException

Returns an array of Files in directory dir. If dir does not exist, if dir is a file, if dir has not got appropriate permissions, or if dir is null a FsException will be thrown.

Parameters:

dir - the directory to list

Returns:

an array of Files

Throws:

FsException - wrapping any underlying Exception

listFiles

default java.io.File[] listFiles(java.io.File dir,
                                 java.io.FileFilter filter)
                          throws FsException

Returns an array of Files in directory dir that match the passed filter. If dir does not exist, if dir is a file, if dir has not got appropriate permissions, or if dir is null a FsException will be thrown.

Parameters:

dir - the directory to list

filter - the FileFilter to apply

Returns:

an array of Files

Throws:

FsException - wrapping any underlying Exception

get

byte[] get(java.io.File file)
    throws FsException

Gets the contents of the specified File. If the file doesn't exist or other I/O problems are encountered a FsException will be thrown.

Parameters:

file - the File to get

Returns:

the contents of the file

Throws:

FsException - wrapping any underlying Exception that may occur

put

void put(byte[] data,
         java.io.File file)
  throws FsException

Writes data to the specified file. If the named file already exists or if part of the path doesn't exist a FsException is thrown.

Parameters:

data - the data to write

file - the file to write to

Throws:

FsException - wrapping any underlying Exception that may occur

rename

default void rename(java.io.File oldFile,
                    java.io.File newFile)
             throws FsException

Renames oldfile to newName. If oldFile does not exist or is a directory, or if newName already exists an FsException is thrown.

Parameters:

oldFile - the file to rename

newFile - the new name for the file

Throws:

FsFilenameExistsException - if newFile exists

FsException - wrapping any underlying Exception that may occur

delete

default void delete(java.io.File file)
             throws FsException

Deletes the specified file. If the file doesn't exist returns quietly.

Parameters:

file - the file to delete in the

Throws:

FsException - wrapping any underlying Exception that may occur

isWriteableDir

default boolean isWriteableDir(java.io.File dir)
                        throws FsException

Returns true if the passed File is a writeable directory, otherwise false.

Parameters:

dir - the directory to check in the

Returns:

true if the passed File is a writeable directory, otherwise false

Throws:

FsException - wrapping any underlying Exception that may occur

checkExists

static java.io.File checkExists(java.io.File file)
                         throws FsException

Throw an exception if the file does not exist.

Throws:

FsException - if the file does not exist

checkNonExistent

static java.io.File checkNonExistent(java.io.File file)
                              throws FsException

Throw an exception if the file exists.

Throws:

FsException - if the file exists

checkReadable

static java.io.File checkReadable(java.io.File file)
                           throws FsException

Throw an exception if the file is not readable

Throws:

FsException

checkWriteable

static java.io.File checkWriteable(java.io.File file)
                            throws FsException

Throw an exception if the file is not readable or writeable

Throws:

FsException

isDirectory

static java.io.File isDirectory(java.io.File file)
                         throws FsException

Throw an exception if the file is not a directory

Throws:

FsException

isFile

static java.io.File isFile(java.io.File file)
                    throws FsException

Throw an exception if the file is not a plain file.

Throws:

FsException