org.jboss.jsfunit.ant
Class Utils

java.lang.Object
  org.jboss.jsfunit.ant.Utils

public class Utils
extends java.lang.Object

Utility Class to handle some file io operations that are extremely useful but for some odd reason not implemeneted in the jdk itself.

Since:

1.0

Author:

Matt Wringe

Constructor Summary

Utils()

Method Summary

static void	archive(java.io.File explodedArchive, java.io.File destArchive) Imploded an already exploded archive
static void	copy(java.io.File srcfile, java.io.File destfile) Copy a file or directory from one location to another
static java.io.File	explodeArchive(java.util.zip.ZipFile archiveFile, java.io.File destDirectory) Creates an exploded war from a war archive
static java.lang.String	getArchiveName(java.util.zip.ZipFile file) The getName() method for a ZipFile returns the full file path and not the name of the actual file.
static void	unzip(java.util.zip.ZipFile zipFile, java.io.File destDirectory) Unzips a zipFile to the specified directory.
static void	zip(java.io.File srcDirectory, java.io.File destFile) Zips a directory
static void	zip(java.io.File srcDirectory, java.io.File destFile, java.lang.Boolean isArchive) Zips a directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

copy

public static void copy(java.io.File srcfile,
                        java.io.File destfile)
                 throws java.lang.Exception

Copy a file or directory from one location to another

Parameters:

srcfile - The file to copy

destfile - The destination for the copied file

Throws:

java.lang.Exception - If an exception occured during the copy

unzip

public static void unzip(java.util.zip.ZipFile zipFile,
                         java.io.File destDirectory)
                  throws java.lang.Exception

Unzips a zipFile to the specified directory.

Parameters:

zipFile - The file to unzip

destDirectory - The directory to unzip the file

Throws:

java.lang.Exception - If an error occurs during the unzipping process

zip

public static void zip(java.io.File srcDirectory,
                       java.io.File destFile)
                throws java.lang.Exception

Zips a directory

Parameters:

srcDirectory - the directory to zip

destFile - the newly created zip file

Throws:

java.lang.Exception

zip

public static void zip(java.io.File srcDirectory,
                       java.io.File destFile,
                       java.lang.Boolean isArchive)
                throws java.lang.Exception

Zips a directory. If the directory is an exploded archive, then don't add the directory itself to the zipped file

Parameters:

srcDirectory - the directory to zip

destFile - the newly created zip file

isArchive - true if the srcDirectory is a exploded archive

Throws:

java.lang.Exception - if an error occured during the zip

explodeArchive

public static java.io.File explodeArchive(java.util.zip.ZipFile archiveFile,
                                          java.io.File destDirectory)
                                   throws java.lang.Exception

Creates an exploded war from a war archive

Parameters:

archiveFile - The war File

destDirectory - The directory to explode the war

Throws:

java.lang.Exception - If an error occurs when exploding the war

getArchiveName

public static java.lang.String getArchiveName(java.util.zip.ZipFile file)

The getName() method for a ZipFile returns the full file path and not the name of the actual file. This method is used to retrieve the file name without the file path.

Parameters:

file - The file to get the file name

archive

public static void archive(java.io.File explodedArchive,
                           java.io.File destArchive)
                    throws java.lang.Exception

Imploded an already exploded archive

Parameters:

explodedArchive - the directory of the exploded archive

destArchive - the name of the new archive to create

Throws:

java.lang.Exception - if an exception occurs during the archive process