org.codehaus.plexus.util
Class Expand

java.lang.Object
  org.codehaus.plexus.util.Expand

public class Expand
extends java.lang.Object

Unzip a file.

Since:

Ant 1.1 @ant.task category="packaging" name="unzip" name="unjar" name="unwar"

Author:

[email protected], Stefan Bodewig, Magesh Umasankar

Constructor Summary

Expand()

Method Summary

void	execute() Do the work.
protected void	expandFile(java.io.File srcF, java.io.File dir) Description of the Method
protected void	extractFile(java.io.File srcF, java.io.File dir, java.io.InputStream compressedInputStream, java.lang.String entryName, java.util.Date entryDate, boolean isDirectory) Description of the Method
java.io.File	normalize(java.lang.String path) "normalize" the given absolute path.
java.io.File	resolveFile(java.io.File file, java.lang.String filename) Interpret the filename as a file relative to the given file - unless the filename already represents an absolute filename.
void	setDest(java.io.File d) Set the destination directory.
void	setOverwrite(boolean b) Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
void	setSrc(java.io.File s) Set the path to zip-file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Expand

public Expand()

Method Detail

execute

public void execute()
             throws java.lang.Exception

Do the work.

Throws:

java.lang.Exception - Thrown in unrecoverable error.

expandFile

protected void expandFile(java.io.File srcF,
                          java.io.File dir)
                   throws java.lang.Exception

Description of the Method

Throws:

java.lang.Exception

extractFile

protected void extractFile(java.io.File srcF,
                           java.io.File dir,
                           java.io.InputStream compressedInputStream,
                           java.lang.String entryName,
                           java.util.Date entryDate,
                           boolean isDirectory)
                    throws java.lang.Exception

Description of the Method

Throws:

java.lang.Exception

setDest

public void setDest(java.io.File d)

Set the destination directory. File will be unzipped into the destination directory.

Parameters:

d - Path to the directory.

setSrc

public void setSrc(java.io.File s)

Set the path to zip-file.

Parameters:

s - Path to zip-file.

setOverwrite

public void setOverwrite(boolean b)

Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?

resolveFile

public java.io.File resolveFile(java.io.File file,
                                java.lang.String filename)

Interpret the filename as a file relative to the given file - unless the filename already represents an absolute filename.

Parameters:

file - the "reference" file for relative paths. This manager must be an absolute file and must not contain "./" or "../" sequences (same for \ instead of /). If it is null, this call is equivalent to new java.io.File(filename).

filename - a file name

Returns:

an absolute file that doesn't contain "./" or "../" sequences and uses the correct separator for the current platform.

normalize

public java.io.File normalize(java.lang.String path)

"normalize" the given absolute path.

This includes:

• Uppercase the drive letter if there is one.
• Remove redundant slashes after the drive spec.
• resolve all ./, .\, ../ and ..\ sequences.
• DOS style paths that start with a drive letter will have \ as the separator.

Throws:

java.lang.NullPointerException - if the file path is equal to null.