org.codehaus.cargo.util
Interface FileHandler

All Known Implementing Classes:

DefaultFileHandler

public interface FileHandler

File operations that are performed in Cargo. All file operations must use this interface. This interface is also useful for unit testing as it's possible to create a mock implementation of it to prevent actual file operations from happening.

Version:

$Id: FileHandler.java 1906 2009-02-19 16:43:11Z mwringe $

Method Summary

String	append(String path, String suffixToAppend) Append a suffix path to an existing path.
void	copy(InputStream in, OutputStream out) Copies data from an InputStream to an OutputStream using a default buffer size.
void	copy(InputStream in, OutputStream out, int bufSize) Copies data from an InputStream to an OutputStream.
void	copyDirectory(String source, String target) Copy a directory from a source to a destination.
void	copyDirectory(String source, String target, List excludes) Copy a directory from a source to a destination specifying files to be excluded.
void	copyFile(String source, String target) Copy a file from a source to a destination specifying if source files may overwrite newer destination files.
void	copyFile(String source, String target, boolean overwrite) Copy a file from a source to a destination specifying if source files may overwrite newer destination files.
void	copyFile(String source, String target, org.apache.tools.ant.types.FilterChain filterChain) Copy a file from a source to a destination using a filterchain to specify token replacement.
String	createDirectory(String parentDir, String name) Convenience method for creating a new directory inside another one.
void	createFile(String file) Create a file.
String	createUniqueTmpDirectory() Creates a unique temporary directory.
void	delete(String path) Deletes a file or directory, removing any children as appropriate.
boolean	exists(String path)
String	getAbsolutePath(String path) gets the absolute path from a file that may be relative to the current directory.
String[]	getChildren(String directory)
InputStream	getInputStream(String file)
String	getName(String file)
OutputStream	getOutputStream(String file)
String	getParent(String path)
String	getTmpPath(String name) Compute the location of a temporary directory.
String	getURL(String path)
boolean	isDirectory(String path)
boolean	isDirectoryEmpty(String dir)
void	mkdirs(String path) Create directories for the passed path.
String	readTextFile(String file)

Method Detail

copyFile

void copyFile(String source,
              String target)

Copy a file from a source to a destination specifying if source files may overwrite newer destination files.

Parameters:

source - the file to copy from. Must not be null.

target - the file to copy to. Must not be null.

copyFile

void copyFile(String source,
              String target,
              boolean overwrite)

Copy a file from a source to a destination specifying if source files may overwrite newer destination files.

Parameters:

source - the file to copy from. Must not be null.

target - the file to copy to. Must not be null.

overwrite - to overwrite the file if it already exists.

copyFile

void copyFile(String source,
              String target,
              org.apache.tools.ant.types.FilterChain filterChain)

Copy a file from a source to a destination using a filterchain to specify token replacement.

Parameters:

source - the file to copy from. Must not be null

target - the file to copy to. Must not be null

filterChain - the filterChain to use. Must not be null

copyDirectory

void copyDirectory(String source,
                   String target)

Copy a directory from a source to a destination.

Parameters:

source - the directory to copy from. Must not be null.

target - the directory to copy to. Must not be null.

copyDirectory

void copyDirectory(String source,
                   String target,
                   List excludes)

Copy a directory from a source to a destination specifying files to be excluded.

Parameters:

source - the directory to copy from. Must not be null.

target - the directory to copy to. Must not be null.

excludes - the list of files to be excluded. Each entry in the list is an Ant file pattern.

createDirectory

String createDirectory(String parentDir,
                       String name)

Convenience method for creating a new directory inside another one. If the directory already exists, it will return the already created directory.

Parameters:

parentDir - The directory in which the new directory should be created

name - The name of the directory to create

Returns:

The new directory

copy

void copy(InputStream in,
          OutputStream out,
          int bufSize)

Copies data from an InputStream to an OutputStream.

Parameters:

in - InputStream to copy data from

out - OutputStream to copy data to

bufSize - size of the copy buffer

copy

void copy(InputStream in,
          OutputStream out)

Copies data from an InputStream to an OutputStream using a default buffer size.

Parameters:

in - InputStream to copy data from

out - OutputStream to copy data to

getTmpPath

String getTmpPath(String name)

Compute the location of a temporary directory.

Parameters:

name - The name of the directory to compute inside the tmp directory

Returns:

the location of the computed temporary directory

createUniqueTmpDirectory

String createUniqueTmpDirectory()

Creates a unique temporary directory.

Returns:

the newly created temporary directory

delete

void delete(String path)

Deletes a file or directory, removing any children as appropriate.

Parameters:

path - the path to the file or directory to remove

getInputStream

InputStream getInputStream(String file)

Parameters:

file - the file for which to get an InputStream for

Returns:

an InputStream pointing to the file

getOutputStream

OutputStream getOutputStream(String file)

Parameters:

file - the file for which to get an OutputStream for

Returns:

an OutputStream pointing to the file

append

String append(String path,
              String suffixToAppend)

Append a suffix path to an existing path.

Parameters:

path - the path to append to

suffixToAppend - the suffix to append to the path

Returns:

the new full path

mkdirs

void mkdirs(String path)

Create directories for the passed path.

Parameters:

path - the path for which to create all directories leading to it

getParent

String getParent(String path)

Parameters:

path - the path for which to return its parent

Returns:

the parent path of the passed path

exists

boolean exists(String path)

Parameters:

path - the path to check the existence for

Returns:

true if the path exists or false otherwise

createFile

void createFile(String file)

Create a file.

Parameters:

file - the file to create

isDirectoryEmpty

boolean isDirectoryEmpty(String dir)

Parameters:

dir - the directory to check

Returns:

true if the passed directory is empty

isDirectory

boolean isDirectory(String path)

Parameters:

path - the path to verify

Returns:

true if the path passed is a directory or false otherwise

getName

String getName(String file)

Parameters:

file - the file name for which to return the file name

Returns:

the file name (without path nor extension)

getURL

String getURL(String path)

Parameters:

path - the path for which to return the URL

Returns:

the URL for the passed path

getChildren

String[] getChildren(String directory)

Parameters:

directory - the directory for which to return all children

Returns:

the children of the passed directory

getAbsolutePath

String getAbsolutePath(String path)

gets the absolute path from a file that may be relative to the current directory.

Parameters:

path - - what to extract the file path from

Returns:

- absolute path to the file

readTextFile

String readTextFile(String file)

Parameters:

file - the file for which to load into a String object.

Returns:

a String with the file's contents.