org.codehaus.mojo.webstart.util

Interface IOUtil

All Known Implementing Classes:

DefaultIOUtil

public interface IOUtil

Helper for all IO operations.

Since:

1.0-beta-4

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Plexus component role.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(ZipFile closeable) Silently closes the resource
void	copyDirectoryStructure(File sourceDirectory, File targetDirectory) Copy directory structure from sourceDirectory to targetDirectory.
void	copyFile(File sourceFile, File targetFile)
boolean	copyFileToDirectoryIfNecessary(File sourceFile, File targetDirectory) Conditionally copy the file into the target directory.
void	copyResources(File sourceDirectory, File targetDirectory) Copy the content of a directory to another one recursively.
void	copyResources(URI uri, ClassLoader classLoader, File target) Copy a resource from the given uri to target file.
void	createArchive(File directory, File archive)
void	deleteFile(File file) Delete a file.
int	deleteFiles(File directory, FileFilter fileFilter)
void	makeDirectoryIfNecessary(File dir) Create the given directory if it does not exist.
void	removeDirectory(File dir) Delete the specified directory.
void	renameTo(File source, File target) Rename a file.
boolean	shouldCopyFile(File sourceFile, File targetFile)

Field Detail

ROLE

static final String ROLE

Plexus component role.

Method Detail

copyResources

void copyResources(File sourceDirectory,
                 File targetDirectory)
                   throws org.apache.maven.plugin.MojoExecutionException

Copy the content of a directory to another one recursively.

Parameters:

sourceDirectory - directory to copy

targetDirectory - where to copy

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not perform operation

copyDirectoryStructure

void copyDirectoryStructure(File sourceDirectory,
                          File targetDirectory)
                            throws org.apache.maven.plugin.MojoExecutionException

Copy directory structure from sourceDirectory to targetDirectory.

Parameters:

sourceDirectory - source of copy

targetDirectory - target of copy

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not perform operation

shouldCopyFile

boolean shouldCopyFile(File sourceFile,
                     File targetFile)

Parameters:

sourceFile - source file

targetFile - target file

Returns:

true if source file should be copy to target location

copyFileToDirectoryIfNecessary

boolean copyFileToDirectoryIfNecessary(File sourceFile,
                                     File targetDirectory)
                                       throws org.apache.maven.plugin.MojoExecutionException

Conditionally copy the file into the target directory. The operation is not performed when the target file exists and is up to date. The target file name is taken from the sourceFile name.

Parameters:

sourceFile - source file to copy

targetDirectory - location of the target directory where to copy file

Returns:

true when the file was copied, false otherwise.

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs attempting to copy the file.

copyFile

void copyFile(File sourceFile,
            File targetFile)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

removeDirectory

void removeDirectory(File dir)
                     throws org.apache.maven.plugin.MojoExecutionException

Delete the specified directory.

Parameters:

dir - the directory to delete

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not delete directory

makeDirectoryIfNecessary

void makeDirectoryIfNecessary(File dir)
                              throws org.apache.maven.plugin.MojoExecutionException

Create the given directory if it does not exist.

will throw an exception if could not perform the operation.

Parameters:

dir - the dir to create if it does not exist

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not create directory

deleteFiles

int deleteFiles(File directory,
              FileFilter fileFilter)
                throws org.apache.maven.plugin.MojoExecutionException

Parameters:

directory - location of directory where to delete some files

fileFilter - filter to select files to delete

Returns:

the number of deleted files

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not delete files

deleteFile

void deleteFile(File file)
                throws org.apache.maven.plugin.MojoExecutionException

Delete a file.

will throw an exception if could not perform the operation.

Parameters:

file - the file to delete

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not delete file

renameTo

void renameTo(File source,
            File target)
              throws org.apache.maven.plugin.MojoExecutionException

Rename a file.

will throw an exception if could not perform the operation.

Parameters:

source - original file to renmae

target - target file

Throws:

org.apache.maven.plugin.MojoExecutionException - if could not rename file

copyResources

void copyResources(URI uri,
                 ClassLoader classLoader,
                 File target)
                   throws org.apache.maven.plugin.MojoExecutionException

Copy a resource from the given uri to target file.

The resource can come from class-path is the scheme is classpath, otherwise will try to get incoming resource from the url obtained from the uri.

Parameters:

uri - uri to copy

classLoader - classloader used to find resource in from classpaht

target - where to copy

Throws:

org.apache.maven.plugin.MojoExecutionException - if something wrong happen

close

void close(ZipFile closeable)

Silently closes the resource

Parameters:

closeable -

createArchive

void createArchive(File directory,
                 File archive)
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException