de.schlichtherle.truezip.sample.file.app
Class CommandLineUtility

java.lang.Object
  de.schlichtherle.truezip.sample.file.app.CommandLineUtility

Direct Known Subclasses:

Decrypt, Encrypt, Nzip, PathCat, Pickr, UriCat

abstract class CommandLineUtility
extends Object

Abstract base class for command line utilities.

Author:

Christian Schlichtherle

out

protected final PrintStream out

The print stream for standard output.

err

protected final PrintStream err

The print stream for error output.

monitor

protected final CommandLineUtility.ProgressMonitor monitor

The command line progress monitor.

CommandLineUtility

protected CommandLineUtility()

Equivalent to CommandLineUtility(System.out, System.err, true).

CommandLineUtility

protected CommandLineUtility(OutputStream out,
                             OutputStream err,
                             boolean autoFlush)

Constructs a new command line utility instance.

Note that this constructor has side effects:

• If Swing based prompting is used, the Hurling Window Feedback is set for feedback on wrong key entry unless the respective system properties have been explicitly set.
• Similarly, the SampleManagerService class is set for obtaining statistics when synchronizing any uncommitted changes to the contents of archive files.

Parameters:

out - the standard output stream.

err - the error output stream.

autoFlush - if the output streams are not PrintStreams, then they are wrapped in a new PrintStream with this as the additional constructor parameter.

configureFeedback

private static void configureFeedback()

Configure the type of the feedback when prompting the user for keys for RAES encrypted ZIP files using the Swing based prompting key manager. If this JVM is running in headless mode, then the configuration is ignored.

configureManagerService

private static void configureManagerService()

run

public final int run(String[] args)

Runs this command line utility. Prints a user readable error message to the error output stream which was provided to the constructor if an error occurs.

Parameters:

args - A non-empty array of Unix-like commands and optional parameters.

Returns:

1 iff the command fails, 0 otherwise.

runChecked

public abstract int runChecked(String[] args)
                        throws CommandLineUtility.IllegalUsageException,
                               IOException

Runs this command line utility. Throws an exception if an error occurs.

Parameters:

args - a non-null array of command line parameters.

Returns:

the return code for System.exit(int).

Throws:

CommandLineUtility.IllegalUsageException - If args does not contain correct commands or parameters.

IOException - On any I/O related exception.