org.codehaus.cargo.util

Class DefaultFileHandler

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.util.DefaultFileHandler

All Implemented Interfaces:

FileHandler, Loggable

public class DefaultFileHandler
extends LoggedObject
implements FileHandler

File operations that are performed in Cargo. All file operations must use this class.

Version:

$Id: DefaultFileHandler.java 3624 2013-05-06 20:07:26Z alitokmen $

Nested Class Summary

Nested classes/interfaces inherited from interface org.codehaus.cargo.util.FileHandler

FileHandler.XmlReplacement

Constructor Summary

Constructors

Constructor and Description
DefaultFileHandler() Initializations.

Method Summary

Methods

Modifier and Type	Method and Description
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, org.apache.tools.ant.types.FilterChain filterChain, String encoding) Copy a directory from a source to a destination using a filterchain to specify token replacement.
void	copyDirectory(String source, String target, List<String> 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.
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)
void	copyFile(String source, String target, org.apache.tools.ant.types.FilterChain filterChain, String encoding) 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)
long	getSize(String file)
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, String encoding)
void	replaceInFile(String file, Map<String,String> replacements, String encoding) Replaces using a map of replacements in a given file.
void	replaceInFile(String file, Map<String,String> replacements, String encoding, boolean ignoreNonExistingProperties) Replaces using a map of replacements in a given file.
void	replaceInXmlFile(String file, Map<FileHandler.XmlReplacement,String> replacements) Replaces using a map of XML replacements in a given file.
void	replaceInXmlFile(String file, Map<FileHandler.XmlReplacement,String> replacements, boolean ignoreNonExistingProperties) Replaces using a map of XML replacements in a given file.
void	writeTextFile(String file, String content, String encoding)

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.cargo.util.log.Loggable

getLogger, setLogger

Constructor Detail

DefaultFileHandler

public DefaultFileHandler()

Initializations.

Method Detail

copyFile

public void copyFile(String source,
            String target)

Copy a file from a source to a destination. If destination file already exists, it is not overwritten.

Specified by:

copyFile in interface FileHandler

Parameters:

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

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

See Also:

FileHandler.copyFile(String, String)

copyFile

public 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.

Specified by:

copyFile in interface FileHandler

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.

See Also:

FileHandler.copyFile(String, String, boolean)

copyFile

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

See Also:

FileHander#copyFile(String, String, FilterChain)

copyFile

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

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

Specified by:

copyFile in interface FileHandler

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

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

See Also:

FileHander#copyFile(String, String, FilterChain, String)

copyDirectory

public void copyDirectory(String source,
                 String target)

Copy a directory from a source to a destination.

Specified by:

copyDirectory in interface FileHandler

Parameters:

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

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

See Also:

FileHandler.copyDirectory(String, String)

copyDirectory

public void copyDirectory(String source,
                 String target,
                 List<String> excludes)

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

Specified by:

copyDirectory in interface FileHandler

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.

See Also:

FileHandler.copyDirectory(String, String)

copyDirectory

public void copyDirectory(String source,
                 String target,
                 org.apache.tools.ant.types.FilterChain filterChain,
                 String encoding)

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

Specified by:

copyDirectory in interface FileHandler

Parameters:

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

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

filterChain - the filterChain to use. Must not be null

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

See Also:

FileHander#copyDirectory(String, String, FilterChain, String)

createDirectory

public 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.

Specified by:

createDirectory in interface FileHandler

Parameters:

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

name - The name of the directory to create

Returns:

The new directory

See Also:

FileHandler.createDirectory(String, String)

copy

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

Copies data from an InputStream to an OutputStream.

Specified by:

copy in interface FileHandler

Parameters:

in - InputStream to copy data from

out - OutputStream to copy data to

bufSize - size of the copy buffer

See Also:

FileHandler.copy(java.io.InputStream, java.io.OutputStream, int)

copy

public void copy(InputStream in,
        OutputStream out)

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

Specified by:

copy in interface FileHandler

Parameters:

in - InputStream to copy data from

out - OutputStream to copy data to

See Also:

FileHandler.copy(java.io.InputStream, java.io.OutputStream, int)

replaceInFile

public void replaceInFile(String file,
                 Map<String,String> replacements,
                 String encoding)
                   throws CargoException

Replaces using a map of replacements in a given file..

Specified by:

replaceInFile in interface FileHandler

Parameters:

file - File to replace in.

replacements - Map containing replacements.

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

Throws:

CargoException - If anything fails, most notably if one of the replacements does not exist in the file.

See Also:

FileHandler.replaceInFile(String, Map, String)

replaceInFile

public void replaceInFile(String file,
                 Map<String,String> replacements,
                 String encoding,
                 boolean ignoreNonExistingProperties)
                   throws CargoException

Replaces using a map of replacements in a given file..

Specified by:

replaceInFile in interface FileHandler

Parameters:

file - File to replace in.

replacements - Map containing replacements.

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

ignoreNonExistingProperties - Whether to ignore if one of the keys cannot be found.

Throws:

CargoException - If anything fails, most notably if one of the replacements does not exist in the file.

See Also:

FileHandler.replaceInFile(String, Map, String, boolean)

replaceInXmlFile

public void replaceInXmlFile(String file,
                    Map<FileHandler.XmlReplacement,String> replacements)
                      throws CargoException

Replaces using a map of XML replacements in a given file..

Specified by:

replaceInXmlFile in interface FileHandler

Parameters:

file - File to replace in.

replacements - Map containing XML replacements.

Throws:

CargoException - If anything fails, most notably if one of the replacements does not exist in the file.

See Also:

FileHandler.replaceInXmlFile(String, Map)

replaceInXmlFile

public void replaceInXmlFile(String file,
                    Map<FileHandler.XmlReplacement,String> replacements,
                    boolean ignoreNonExistingProperties)
                      throws CargoException

Replaces using a map of XML replacements in a given file..

Specified by:

replaceInXmlFile in interface FileHandler

Parameters:

file - File to replace in.

replacements - Map containing XML replacements.

ignoreNonExistingProperties - Whether to ignore if one of the keys cannot be found.

Throws:

CargoException - If anything fails, most notably if one of the replacements does not exist in the file.

See Also:

FileHandler.replaceInXmlFile(String, Map, boolean)

getTmpPath

public String getTmpPath(String name)

Compute the location of a temporary directory.

Specified by:

getTmpPath in interface FileHandler

Parameters:

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

Returns:

the location of the computed temporary directory

See Also:

FileHandler.getTmpPath(String)

createUniqueTmpDirectory

public String createUniqueTmpDirectory()

Creates a unique temporary directory.

Specified by:

createUniqueTmpDirectory in interface FileHandler

Returns:

the newly created temporary directory

See Also:

FileHandler.createUniqueTmpDirectory()

delete

public void delete(String path)

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

Specified by:

delete in interface FileHandler

Parameters:

path - the path to the file or directory to remove

See Also:

FileHandler.delete(String)

getSize

public long getSize(String file)

Specified by:

getSize in interface FileHandler

Parameters:

file - the file for which to get the size

Returns:

long Size of the file, in bytes

See Also:

FileHandler.getSize(String)

getInputStream

public InputStream getInputStream(String file)

Specified by:

getInputStream in interface FileHandler

Parameters:

file - the file for which to get an InputStream for

Returns:

an InputStream pointing to the file

See Also:

FileHandler.getInputStream(String)

getOutputStream

public OutputStream getOutputStream(String file)

Specified by:

getOutputStream in interface FileHandler

Parameters:

file - the file for which to get an OutputStream for

Returns:

an OutputStream pointing to the file

See Also:

FileHandler.getOutputStream(String)

append

public String append(String path,
            String suffixToAppend)

Append a suffix path to an existing path.

Specified by:

append in interface FileHandler

Parameters:

path - the path to append to

suffixToAppend - the suffix to append to the path

Returns:

the new full path

See Also:

FileHandler.append(String, String)

mkdirs

public void mkdirs(String path)

Create directories for the passed path.

Specified by:

mkdirs in interface FileHandler

Parameters:

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

See Also:

FileHandler.mkdirs(String)

getParent

public String getParent(String path)

Specified by:

getParent in interface FileHandler

Parameters:

path - the path for which to return its parent

Returns:

the parent path of the passed path

See Also:

FileHandler.getParent(String)

exists

public boolean exists(String path)

Specified by:

exists in interface FileHandler

Parameters:

path - the path to check the existence for

Returns:

true if the path exists or false otherwise

See Also:

FileHandler.exists(String)

createFile

public void createFile(String file)

Create a file.

Specified by:

createFile in interface FileHandler

Parameters:

file - the file to create

See Also:

FileHandler.createFile(String)

isDirectoryEmpty

public boolean isDirectoryEmpty(String dir)

Specified by:

isDirectoryEmpty in interface FileHandler

Parameters:

dir - the directory to check

Returns:

true if the passed directory is empty

See Also:

FileHandler.isDirectoryEmpty(String)

getName

public String getName(String file)

Specified by:

getName in interface FileHandler

Parameters:

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

Returns:

the file name (without path)

See Also:

FileHandler.getName(String)

getURL

public String getURL(String path)

Specified by:

getURL in interface FileHandler

Parameters:

path - the path for which to return the URL

Returns:

the URL for the passed path

See Also:

FileHandler.getURL(String)

isDirectory

public boolean isDirectory(String path)

Specified by:

isDirectory in interface FileHandler

Parameters:

path - the path to verify

Returns:

true if the path passed is a directory or false otherwise

See Also:

FileHandler.isDirectory(String)

getChildren

public String[] getChildren(String directory)

Specified by:

getChildren in interface FileHandler

Parameters:

directory - the directory for which to return all children

Returns:

the children of the passed directory

See Also:

FileHandler.getChildren(String)

getAbsolutePath

public String getAbsolutePath(String path)

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

Specified by:

getAbsolutePath in interface FileHandler

Parameters:

path - - what to extract the file path from

Returns:

- absolute path to the file

See Also:

FileHandler.getAbsolutePath(String)

readTextFile

public String readTextFile(String file,
                  String encoding)

Specified by:

readTextFile in interface FileHandler

Parameters:

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

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

Returns:

a String with the file's contents.

See Also:

FileHandler.readTextFile(String, String)

writeTextFile

public void writeTextFile(String file,
                 String content,
                 String encoding)

Specified by:

writeTextFile in interface FileHandler

Parameters:

file - the file in which to write the String object.

content - String to write into the file.

encoding - The character encoding to use, may be null or empty to use the platform's default encoding.

See Also:

FileHandler.writeTextFile(String, String, String)