org.eclipse.sphinx.platform.cli

Class AbstractCLIApplication

java.lang.Object

org.eclipse.sphinx.platform.cli.AbstractCLIApplication

All Implemented Interfaces:

org.eclipse.equinox.app.IApplication

Direct Known Subclasses:

BasicWorkflowRunnerApplication

public abstract class AbstractCLIApplication
extends java.lang.Object
implements org.eclipse.equinox.app.IApplication

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_HELP_WIDTH Default with used when printing command line usage help.
protected java.io.PrintStream	err
static java.lang.Object	ERROR_NO Error code to indicate that everything is fine.
static java.lang.Object	ERROR_UNSPECIFIED General purpose error code used to indicate that something went wrong.
protected java.io.PrintStream	out

Fields inherited from interface org.eclipse.equinox.app.IApplication

EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART

Constructor Summary

Constructors

Constructor and Description
AbstractCLIApplication()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOption(org.apache.commons.cli.Option option) Registers given option as supported command line option.
protected org.apache.commons.cli.CommandLineParser	createParser() Creates an instance of the command line parser to be used for analyzing the application arguments.
protected void	defineOptions() Returns the set of command line options to be used for parsing the application arguments.
protected java.lang.String[]	getApplicationArgs() Returns the list of arguments passed to this application.
protected java.lang.String	getApplicationDescription() Returns a brief description of what this application is doing.
protected java.lang.String	getApplicationName() Deprecated. Use getCommandLineSyntax() instead.
protected org.apache.commons.cli.CommandLine	getCommandLine() Returns the command line resulting of the parsing operation on application arguments.
protected java.lang.String	getCommandLineSyntax() Returns the command line syntax for this application.
protected org.apache.commons.cli.Options	getOptions() Returns the supported command line options.
protected org.apache.commons.cli.CommandLineParser	getParser() Returns the command line parser to be used for analyzing the application arguments.
protected java.lang.Object	handleError(java.lang.Throwable throwable) Central place for handling errors occurring while this application is run.
protected java.lang.Object	interrogate() Implements the interrogation stage that is invoked after the parsing stage analyzing the command line options.
protected boolean	isHelpNeeded(org.apache.commons.cli.CommandLine commandLine) Determines if command line usage help needs to be printed.
protected void	parse() Parses the application arguments based on the command line Options supported by this application.
protected void	printHelp() Prints the command line usage help.
java.lang.Object	run(java.lang.String[] args) Alternative entry point that can be used to invoke this application from non-Eclipse headless contexts (e.g., Ant task, Java standalone application).
void	setErrorStream(java.io.PrintStream err) Uses given print stream as substitution for System.err and uses it for all subsequent writes to the "standard" error output stream.
void	setOutputStream(java.io.PrintStream out) Uses given print stream as substitution for System.out and uses it for all subsequent writes to the "standard" output stream.
java.lang.Object	start(org.eclipse.equinox.app.IApplicationContext context)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_NO

public static final java.lang.Object ERROR_NO

Error code to indicate that everything is fine.

ERROR_UNSPECIFIED

public static final java.lang.Object ERROR_UNSPECIFIED

General purpose error code used to indicate that something went wrong.

Clients typically define application-specific error codes with values greater than 1 to give a hint at the cause that has led to a failure. Applications which do not require such sophisticated error handling may rely on this error code instead.

DEFAULT_HELP_WIDTH

protected static final int DEFAULT_HELP_WIDTH

Default with used when printing command line usage help.

See Also:

printHelp(), Constant Field Values

out

protected java.io.PrintStream out

err

protected java.io.PrintStream err

Constructor Detail

AbstractCLIApplication

public AbstractCLIApplication()

Method Detail

getApplicationName

@Deprecated
protected java.lang.String getApplicationName()

Deprecated. Use getCommandLineSyntax() instead.

Returns the name of this application.

Returns:

The application's name.

getApplicationDescription

protected java.lang.String getApplicationDescription()

Returns a brief description of what this application is doing.

Returns:

Theapplication's description.

getCommandLineSyntax

protected java.lang.String getCommandLineSyntax()

Returns the command line syntax for this application. Is expected to include relevant Eclipse runtime options, application id, and arguments but not a detailed description of the command line options. The latter is automatically added upon printing the application's help with printHelp(). E.g.,

 eclipse -noSplash -data  -application org.example.cli.SomeApplication [options] file
 

Returns:

The application's command line syntax.

See Also:

printHelp()

getApplicationArgs

protected java.lang.String[] getApplicationArgs()

Returns the list of arguments passed to this application.

Returns:

The application's argument list.

getOptions

protected org.apache.commons.cli.Options getOptions()

Returns the supported command line options.

Returns:

The supported command line options.

addOption

protected void addOption(org.apache.commons.cli.Option option)

Registers given option as supported command line option.

Parameters:

option -

getCommandLine

protected org.apache.commons.cli.CommandLine getCommandLine()

Returns the command line resulting of the parsing operation on application arguments.

Returns:

The command line resulting of the parsing operation on application arguments.

setOutputStream

public void setOutputStream(java.io.PrintStream out)

Uses given print stream as substitution for System.out and uses it for all subsequent writes to the "standard" output stream.

Parameters:

out - The print stream to be used instead of System.out.

See Also:

System.out

setErrorStream

public void setErrorStream(java.io.PrintStream err)

Uses given print stream as substitution for System.err and uses it for all subsequent writes to the "standard" error output stream.

Parameters:

err - The print stream to be used instead of System.err.

See Also:

System.err

start

public java.lang.Object start(org.eclipse.equinox.app.IApplicationContext context)

Specified by:

start in interface org.eclipse.equinox.app.IApplication

stop

public void stop()

Specified by:

stop in interface org.eclipse.equinox.app.IApplication

run

public java.lang.Object run(java.lang.String[] args)

Alternative entry point that can be used to invoke this application from non-Eclipse headless contexts (e.g., Ant task, Java standalone application).

Parameters:

args - The arguments for the application. The content of this argument will be checked for if it conforms to the expectations of the application being invoked.

Returns:

The return code of the application indicating normal or abnormal termination.

defineOptions

protected void defineOptions()

Returns the set of command line options to be used for parsing the application arguments. The command line usage help option is supported by default.

Clients should override this method to provide their own command line options.

See Also:

http://commons.apache.org/cli/usage.html

parse

protected void parse()
              throws org.apache.commons.cli.ParseException

Parses the application arguments based on the command line Options supported by this application.

Throws:

org.apache.commons.cli.ParseException

See Also:

#defineOptions()}

getParser

protected org.apache.commons.cli.CommandLineParser getParser()

Returns the command line parser to be used for analyzing the application arguments.

Returns:

The command line parser to be used for analyzing application arguments.

createParser

protected org.apache.commons.cli.CommandLineParser createParser()

Creates an instance of the command line parser to be used for analyzing the application arguments. Three command line parser types are available out-of-the box: BasicParser, GnuParser, PosixParser. In addition, clients are free to provide and use their own command line parser implementations.

Returns:

The command line parser instance to be used for analyzing application arguments.

See Also:

defineOptions(), http://commons.apache.org/cli/usage.html

interrogate

protected java.lang.Object interrogate()
                                throws java.lang.Throwable

Implements the interrogation stage that is invoked after the parsing stage analyzing the command line options. It is the place where this application's semantics according to the command line options that have been detected in the application arguments needs to be defined. The semantics for the command line usage help option is implemented by default.

Clients should override this method to implement the semantics for their own command line options.

Throws:

java.lang.Throwable

See Also:

defineOptions(), http://commons.apache.org/cli/usage.html

isHelpNeeded

protected boolean isHelpNeeded(org.apache.commons.cli.CommandLine commandLine)

Determines if command line usage help needs to be printed.

Returns:

true if command line usage help needs to be printed, false otherwise.

printHelp

protected void printHelp()

Prints the command line usage help.

handleError

protected java.lang.Object handleError(java.lang.Throwable throwable)

Central place for handling errors occurring while this application is run.

Parameters:

throwable - The exception describing the error that has occurred.

Returns:

The corresponding error code to be returned by this application.