net.morimekta.console.args

Class ArgumentParser

java.lang.Object

net.morimekta.console.args.ArgumentParser

public class ArgumentParser
extends Object

Argument argumentParser class. This is the actual argumentParser that is initialized with a set of options, arguments and properties, and is then initialized with the appropriate fields.

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(String program, String version, String description) Create an argument argumentParser instance.
ArgumentParser(String program, String version, String description, ArgumentOptions argumentOptions) Create an argument argumentParser instance.

Method Summary

Modifier and Type	Method and Description
<A extends BaseArgument> ArgumentParser	add(A arg) Add a sub-command.
<O extends BaseOption> ArgumentParser	add(O option) Add a command line option.
String	getDescription() Short description of the program.
String	getProgram() The name of the program.
String	getProgramDescription() Get the program description line.
String	getSingleLineUsage() Get the single line usage string for the parser.
String	getVersion() The program version string.
void	parse(ArgumentList args) Parse arguments from the main method.
void	parse(String... args) Parse arguments from the main method.
void	printUsage(OutputStream out) Print the option usage list.
void	printUsage(OutputStream out, boolean showHidden) Print the option usage list.
void	printUsage(PrintWriter writer, boolean showHidden) Print the option usage list.
void	validate() Validate all options and arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentParser

public ArgumentParser(String program,
                      String version,
                      String description)

Create an argument argumentParser instance.

Parameters:

program - The program name.

version - The program version.

description - The program description.

ArgumentParser

public ArgumentParser(String program,
                      String version,
                      String description,
                      ArgumentOptions argumentOptions)

Create an argument argumentParser instance.

Parameters:

program - The program name.

version - The program version.

description - The program description.

argumentOptions - The argument options.

Method Detail

getProgram

public String getProgram()

The name of the program. Should be essentially what the user types on the command line to invoke the program.

Returns:

The program name.

getVersion

public String getVersion()

The program version string.

Returns:

The program version.

getDescription

public String getDescription()

Short description of the program. Should be the string that is shown on the top of the program usage help, usually just a few words. Should be capitalized.

Returns:

The program description.

add

public <O extends BaseOption> ArgumentParser add(O option)

Add a command line option.

Type Parameters:

O - The base option type.

Parameters:

option - The option to add.

Returns:

The argument argumentParser.

add

public <A extends BaseArgument> ArgumentParser add(A arg)

Add a sub-command.

Type Parameters:

A - The base argument type.

Parameters:

arg - The command to add.

Returns:

The argument argumentParser.

parse

public void parse(String... args)

Parse arguments from the main method.

Parameters:

args - The argument array.

parse

public void parse(ArgumentList args)

Parse arguments from the main method.

Parameters:

args - The argument list.

validate

public void validate()

Validate all options and arguments.

printUsage

public void printUsage(OutputStream out)

Print the option usage list. Essentially printed as a list of options with the description indented where it overflows the available line width.

Parameters:

out - The output stream.

printUsage

public void printUsage(OutputStream out,
                       boolean showHidden)

Print the option usage list. Essentially printed as a list of options with the description indented where it overflows the available line width.

Parameters:

out - The output stream.

showHidden - Whether to show hidden options.

printUsage

public void printUsage(PrintWriter writer,
                       boolean showHidden)

Print the option usage list. Essentially printed as a list of options with the description indented where it overflows the available line width.

Parameters:

writer - The output printer.

showHidden - Whether to show hidden options.

getProgramDescription

public String getProgramDescription()

Get the program description line. Contains essentially the line "description - version".

Returns:

The program description.

getSingleLineUsage

public String getSingleLineUsage()

Get the single line usage string for the parser. Contains essentially the line "program options args".

Returns:

The single line usage.