de.enflexit.common.transfer

Class Zipper

java.lang.Object

java.lang.Thread

de.enflexit.common.transfer.Zipper

All Implemented Interfaces:

java.lang.Runnable

public class Zipper
extends java.lang.Thread

This class can be used in order zip or unzip a folder structure.

Example of the usage for zipping:

Zipper zipper = new Zipper();
zipper.setExcludePattern(".svn");
zipper.setZipFolder(zipFolder);
zipper.setZipSourceFolder(srcFolder);
zipper.doZipFolder();


Example of the usage for unzipping:

Zipper zipper = new Zipper();
zipper.setUnzipZipFolder(zipFolder);
zipper.setUnzipDestinationFolder(destFolder);
zipper.doUnzipFolder();


Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Zipper() Instantiates a new Zipper.
Zipper(java.awt.Frame owner) Instantiates a new Zipper.

Method Summary

Modifier and Type	Method and Description
void	doUnzipFolder() Will do the unzipping of the previously specified zip-file
void	doZipFolder() This method can be invoked after the parameters are set for zipping a folder.
java.lang.String	getExcludePattern() This method returns the current String, which is used for excluding files to be packed to the zip-file.
java.awt.Image	getIconImage() Returns the icon image for the visualization of the zip progress.
java.lang.String	getLookAndFeelClassName() Returns the look and feel class reference.
java.lang.String	getRootFolder2Extract() This method will evaluate the zip-file in order to find the root-folder of the zip
java.lang.String	getUnzipDestinationFolder() Get the current destination folder for unzipping here
java.lang.String	getUnzipZipFolder() Get the currently specified zipFile/Folder here
java.lang.String	getZipFolder() Returns the path to the current zip-file for zipping a folder structure
java.lang.String	getZipSourceFolder() Get the current source folder for packing into a zip-file
boolean	isDone() Checks if the operation is done.
boolean	isHeadlessOperation() Checks if is headless (un)zip operation.
boolean	isRunInThread() Return if the defined process is to be executed in an own thread.
void	run() Starts the execution of the zip- or unzip process in the current thread.
void	setAfterJobTask(java.lang.Runnable afterJobTask) Sets the after job task.
void	setApplicationName(java.lang.String applicationName) Sets the application name.
void	setDone(boolean done) Sets that the operation is done.
void	setExcludePattern(java.lang.String excludePattern) This exclude pattern can be used in oder to prevent some types of files to be packed.
void	setIconImage(java.awt.Image iconImage) Sets the icon image for the visualization of the zip progress.
void	setLookAndFeelClassName(java.lang.String lookAndFeelClassReference) Sets the look and feel class reference.
void	setRunInThread(boolean isRunInThread) Sets to execute the defined process in an own thread or not (the default is true).
void	setUnzipDestinationFolder(java.lang.String unzipDestinationFolder) Set the destination folder for unzipping a zip-File/Folder here
void	setUnzipZipFolder(java.lang.String zipFolder) Specify the zip-File/Folder here, which has to unpacked
void	setZipFolder(java.lang.String zipFolder) This method can be used in order to specify the zip-file, which has to be packed
void	setZipSourceFolder(java.lang.String zipSourceFolder) Define the source folder, which has to be packed here.
void	startInCurrentThread() Does the actual Zipper action.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

Zipper

public Zipper()

Instantiates a new Zipper.

Zipper

public Zipper(java.awt.Frame owner)

Instantiates a new Zipper.

Parameters:

owner - the owner frame of the zipper

Method Detail

setRunInThread

public void setRunInThread(boolean isRunInThread)

Sets to execute the defined process in an own thread or not (the default is true).

Parameters:

isRunInThread - the new extract in thread

isRunInThread

public boolean isRunInThread()

Return if the defined process is to be executed in an own thread.

Returns:

true, if is extract in thread

setDone

public void setDone(boolean done)

Sets that the operation is done.

Parameters:

done - the new done

isDone

public boolean isDone()

Checks if the operation is done.

Returns:

true, if is done

run

public void run()

Starts the execution of the zip- or unzip process in the current thread.
During the process a Zip-Monitor will be shown to the user.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

startInCurrentThread

public void startInCurrentThread()

Does the actual Zipper action. Call this method, if you want to do the zipping or unzipping in the current thread. Otherwise use the Thread.start() method of the thread want to do the action

setApplicationName

public void setApplicationName(java.lang.String applicationName)

Sets the application name.

Parameters:

applicationName - the new application name

setIconImage

public void setIconImage(java.awt.Image iconImage)

Sets the icon image for the visualization of the zip progress.

Parameters:

iconImage - the new icon image

getIconImage

public java.awt.Image getIconImage()

Returns the icon image for the visualization of the zip progress.

Returns:

the icon image

setLookAndFeelClassName

public void setLookAndFeelClassName(java.lang.String lookAndFeelClassReference)

Sets the look and feel class reference.

Parameters:

lookAndFeelClassName - the new look and feel class reference

getLookAndFeelClassName

public java.lang.String getLookAndFeelClassName()

Returns the look and feel class reference.

Returns:

the look and feel class reference

setAfterJobTask

public void setAfterJobTask(java.lang.Runnable afterJobTask)

Sets the after job task.

Parameters:

afterJobTask - the new after job task

setExcludePattern

public void setExcludePattern(java.lang.String excludePattern)

This exclude pattern can be used in oder to prevent some types of files to be packed. We use this method to prevent zipping the svn-folder structure during the project export.

Parameters:

excludePattern - the excludePattern to set

getExcludePattern

public java.lang.String getExcludePattern()

This method returns the current String, which is used for excluding files to be packed to the zip-file.

Returns:

the excludePattern

setZipFolder

public void setZipFolder(java.lang.String zipFolder)

This method can be used in order to specify the zip-file, which has to be packed

Parameters:

zipFolder - the zip-folder to set

getZipFolder

public java.lang.String getZipFolder()

Returns the path to the current zip-file for zipping a folder structure

Returns:

the zipZipFolder

setZipSourceFolder

public void setZipSourceFolder(java.lang.String zipSourceFolder)

Define the source folder, which has to be packed here.

Parameters:

zipSourceFolder - the zipSourceFolder to set

getZipSourceFolder

public java.lang.String getZipSourceFolder()

Get the current source folder for packing into a zip-file

Returns:

the zipSourceFolder

setUnzipZipFolder

public void setUnzipZipFolder(java.lang.String zipFolder)

Specify the zip-File/Folder here, which has to unpacked

Parameters:

zipFolder - the zip-folder to unzip

getUnzipZipFolder

public java.lang.String getUnzipZipFolder()

Get the currently specified zipFile/Folder here

Returns:

the zip-folder to unzip

setUnzipDestinationFolder

public void setUnzipDestinationFolder(java.lang.String unzipDestinationFolder)

Set the destination folder for unzipping a zip-File/Folder here

Parameters:

unzipDestinationFolder - the destination folder for unzipping

getUnzipDestinationFolder

public java.lang.String getUnzipDestinationFolder()

Get the current destination folder for unzipping here

Returns:

the unzipDestinationFolder

isHeadlessOperation

public boolean isHeadlessOperation()

Checks if is headless (un)zip operation.

Returns:

true, if is a headless (un)zip operation

getRootFolder2Extract

public java.lang.String getRootFolder2Extract()

This method will evaluate the zip-file in order to find the root-folder of the zip

Returns:

Returns the root folder name of the zip-file

doUnzipFolder

public void doUnzipFolder()

Will do the unzipping of the previously specified zip-file

Throws:

java.lang.Exception

doZipFolder

public void doZipFolder()

This method can be invoked after the parameters are set for zipping a folder.
See example above.