org.foray.app
Class FOray

java.lang.Object
  org.foray.app.FOray

public final class FOray
extends Object

Command-line entry point to the FOray application.

Field Summary

static String	COMMAND_LINE_EXAMPLE_001 Command-line example for testing and documentation.
static String	COMMAND_LINE_EXAMPLE_002 Command-line example for testing and documentation.
static String	COMMAND_LINE_EXAMPLE_003 Command-line example for testing and documentation.
static String	COMMAND_LINE_EXAMPLE_004 Command-line example for testing and documentation.
static String[]	COMMAND_LINE_EXAMPLES Examples of command-line arguments.
static byte	STATUS_COMMAND_LINE_ERROR Command-line status constant indicating that the command line itself was not properly formed.

Method Summary

static String	getUsage() Shows the commandline syntax including a summary of all available options and some examples.
String	getUsagePrintOutput() Shows the options for print output.
static void	main(String[] args) Main command-line entry point to FOray.
static org.apache.commons.cli.CommandLine	parseCommandLine(org.apache.commons.cli.Options commandLineOptions, String[] args) Parses a command-line.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_COMMAND_LINE_ERROR

public static final byte STATUS_COMMAND_LINE_ERROR

Command-line status constant indicating that the command line itself was not properly formed.

See Also:

Constant Field Values

COMMAND_LINE_EXAMPLE_001

public static final String COMMAND_LINE_EXAMPLE_001

Command-line example for testing and documentation.

See Also:

Constant Field Values

COMMAND_LINE_EXAMPLE_002

public static final String COMMAND_LINE_EXAMPLE_002

Command-line example for testing and documentation.

See Also:

Constant Field Values

COMMAND_LINE_EXAMPLE_003

public static final String COMMAND_LINE_EXAMPLE_003

Command-line example for testing and documentation.

See Also:

Constant Field Values

COMMAND_LINE_EXAMPLE_004

public static final String COMMAND_LINE_EXAMPLE_004

Command-line example for testing and documentation.

See Also:

Constant Field Values

COMMAND_LINE_EXAMPLES

public static final String[] COMMAND_LINE_EXAMPLES

Examples of command-line arguments. These are used for testing, and for generating help documentation.

Method Detail

getUsage

public static String getUsage()

Shows the commandline syntax including a summary of all available options and some examples.

Returns:

The usage message for this application.

getUsagePrintOutput

public String getUsagePrintOutput()

Shows the options for print output.

Returns:

The available options for the "-print" output option.

parseCommandLine

public static org.apache.commons.cli.CommandLine parseCommandLine(org.apache.commons.cli.Options commandLineOptions,
                                                                  String[] args)
                                                           throws org.apache.commons.cli.ParseException

Parses a command-line.

Parameters:

commandLineOptions - The command-line options controlling the parsing.

args - The command-line arguments to be parsed.

Returns:

The results of the parsing.

Throws:

org.apache.commons.cli.ParseException - For errors in args.

main

public static void main(String[] args)

Main command-line entry point to FOray.

Parameters:

args - The command-line arguments. See the application documentation for details on these arguments.