com.fulcrumgenomics.sopt.cmdline
CommandLineProgramParser
Related Doc:
package cmdline
Error messages
Error messages
Similarity floor for when searching for similar sub-command names.
Similarity floor for when searching for similar sub-command names. *
Section separator
Section separator
The maximum line lengths for tool descriptions
The maximum line lengths for tool descriptions
Lengths for names and descriptions on the command line
Lengths for names and descriptions on the command line
Section headers
Section headers
Gets the command line assuming parseTasks has been called
The command line name.
The command line name.
Formats the short description of a tool when printing out the list of sub-commands in the usage.
Formats the short description of a tool when printing out the list of sub-commands in the usage.
(1) find the first period (".") and keep only everything before it (2) shorten it to the maximum line length adding "..." to the end.
The name of "command" on the command line
The name of "command" on the command line
The instance of type T that is None initially, and will be populated with a T after a successful parse().
Parses the command line arguments for a given class and attempts to instantiate the class.
Parses the command line arguments for a given class and attempts to instantiate the class.
Appends any errors to the stringBuilder if parsing is unsuccessful.
the args to parse.
an instance of the class T if we successfully parsed the args, false otherwise
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program, like this:
A typical command line program will call this to get the beginning of the usage message, and then append a description of the program, like this:
Print a usage message for a given command line task.
Print a usage message for a given command line task.
include the version in the standard preamble.
include command line arguments marked as special.
Class for parsing the command line for a single command line program.
The main entry point is parseAndBuild(). The arguments given to this method should match the annotated arguments to the program's constructor. Constructor arguments can be annotated with com.fulcrumgenomics.sopt.arg while constructors themselves can be annotated with com.fulcrumgenomics.sopt.clp. The latter may be omitted, but is useful for grouping related command line programs and having a common description.