org.goots.exploder

Class Exploder

java.lang.Object

org.goots.exploder.Exploder

public class Exploder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARCHIVE_UNPACK_SUFFIX Use a unique suffix for unpacking archives.

Constructor Summary

Constructors

Constructor and Description
Exploder()

Method Summary

Modifier and Type	Method and Description
Exploder	excludeSuffix(String suffix) Register suffix to ignore when exploding the archive(s).
Set<String>	getSupportedSuffixes()
void	unpack(ExploderFileProcessor processor, File root) Unpacks the contents of the file/directory, decompressing and unarchiving recursively.
void	unpack(File root) Unpacks the contents of the file/directory, decompressing and unarchiving recursively.
Exploder	useTemporaryDirectory() This will configure the current instance to use a temporary directory to copy the target File to prior to unpacking.
Exploder	useWorkingDirectory(File workingDirectory) This will configure the current instance to use the specified working directory and copy the target File to it prior to unpacking.

Methods inherited from class java.lang.Object

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

Field Detail

ARCHIVE_UNPACK_SUFFIX

public static final String ARCHIVE_UNPACK_SUFFIX

Use a unique suffix for unpacking archives.

Constructor Detail

Exploder

public Exploder()

Method Detail

excludeSuffix

public Exploder excludeSuffix(String suffix)
                       throws InternalException

Register suffix to ignore when exploding the archive(s).

Parameters:

suffix - the suffix to ignore e.g. .jar

Returns:

the current Exploder instance.

Throws:

InternalException - if an error occurs.

useTemporaryDirectory

public Exploder useTemporaryDirectory()
                               throws InternalException

This will configure the current instance to use a temporary directory to copy the target File to prior to unpacking. This is useful if running the ExploderFileProcessor on an archive. This WILL delete the temporary directory on completion.

Returns:

the current Exploder instance.

Throws:

InternalException - if an error occurs.

useWorkingDirectory

public Exploder useWorkingDirectory(File workingDirectory)

This will configure the current instance to use the specified working directory and copy the target File to it prior to unpacking. It will NOT delete the working directory on completion.

Parameters:

workingDirectory - the specified working directory to configure.

Returns:

the current Exploder instance.

getSupportedSuffixes

public Set<String> getSupportedSuffixes()

unpack

public void unpack(File root)
            throws InternalException

Unpacks the contents of the file/directory, decompressing and unarchiving recursively. If a working/temporary directory has been set it will copy everything to that first. If a temporary directory has been configured it will be cleaned up at the end.

Parameters:

root - root file (or directory contents) to explode

Throws:

InternalException - if an error occurs.

unpack

public void unpack(ExploderFileProcessor processor,
                   File root)
            throws InternalException

Unpacks the contents of the file/directory, decompressing and unarchiving recursively. It will use the specified ExploderFileProcessor on each target file. If a working/temporary directory has been set it will copy everything to that first. If a temporary directory has been configured it will be cleaned up at the end.

Parameters:

processor - the optional FileProcessor

root - root file (or directory contents) to explode

Throws:

InternalException - if an error occurs.