com.eibus.util

Class CommandLine

java.lang.Object

com.eibus.util.CommandLine

public class CommandLine
extends java.lang.Object

A class for parsing command line arguments in a GNU-like way.

Some terminology used below:

• a parameter is a string mentioned on the command line, or more narrowly any such string that is not an option or an argument.
• an option is anything starting with "-", such as "--file", that is not an argument or "--".
• an argument is given with an option, e.g. "fileName" is the argument of "--file" in the combination "--file fileName".
• a flag option is an option that may not have an argument;
• a flarg option is an option that may or may not have an argument;
• an arg option is an option that must have an argument.

Features to be added, roughly in order of importance:

• Allow option equivalences to be specified (such as "-h" being equivalent to "--help").
• Optional case insensitivity for option names.
• More precise error reporting in the parse() method.
• Allow option override, so that "-f file1 -f file2" is equivalent to "-f file2".
• Set and check for every option whether multiple occurrences are allowed.
• Design a single string syntax for specifying all options, as with the C getopt() function.
• Allow setting of default arguments for options.
• Allow negation of options of the form "--no-xxx" or "--noxxx".
• Allow abbreviations, such as "-depr" for "--deprecation".
• Let the parser do wildcard expansion.

Version:

1.10

Author:

Marnix Klooster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandLine.OptionStyle This class is used to store the option style.
static class	CommandLine.ParseException An Exception thrown by the CommandLine class.
static class	CommandLine.ParseResult This class is used to store the result of a command line parse.
static class	CommandLine.ResponseFileExpander This class expands a response file.
static class	CommandLine.ValidOptions This class is used to store and check which options are valid.

Constructor Summary

Constructors

Constructor and Description
CommandLine() Create an empty CommandLine instance; no parsing is done.
CommandLine(java.lang.String[] args) Create a CommandLine parser for the given command line; no parsing is done.
CommandLine(java.lang.String[] args, java.util.List<java.lang.String> flagOptions, java.util.List<java.lang.String> flargOptions, java.util.List<java.lang.String> argOptions) Parse a command line using the given options.
CommandLine(java.lang.String[] args, java.lang.String[] flagOptions, java.lang.String[] flargOptions, java.lang.String[] argOptions) Parse a command line using the given options.
CommandLine(java.lang.String[] args, java.lang.String flagOptions, java.lang.String flargOptions) Parse a command line using short options only.
CommandLine(java.lang.String[] args, java.lang.String flagOptions, java.lang.String flargOptions, java.lang.String argOptions) Parse a command line using the given short options.
CommandLine(java.lang.String[] args, java.lang.String shortFlagOptions, java.lang.String shortFlargOptions, java.lang.String[] longFlagOptions, java.lang.String[] longFlargOptions) Parse a command line using the given short and options.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCommandLine() Get (a clone of) the command line.
CommandLine.OptionStyle	optionStyle() Get the option style.
void	parse() Parse the command line.
CommandLine.ParseResult	parseResult() Get the parse result.
void	setCommandLine(java.lang.String[] args) Set the command line.
CommandLine.ValidOptions	validOptions() Get the valid options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine()

Create an empty CommandLine instance; no parsing is done.

CommandLine

public CommandLine(java.lang.String[] args)

Create a CommandLine parser for the given command line; no parsing is done.

Parameters:

args - a command line

CommandLine

public CommandLine(java.lang.String[] args,
                   java.lang.String[] flagOptions,
                   java.lang.String[] flargOptions,
                   java.lang.String[] argOptions)
            throws CommandLine.ParseException

Parse a command line using the given options.

Parameters:

args - the command line to be parsed

flagOptions - the flag options allowed

flargOptions - the flarg options allowed

argOptions - the flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

CommandLine

public CommandLine(java.lang.String[] args,
                   java.lang.String flagOptions,
                   java.lang.String flargOptions)
            throws CommandLine.ParseException

Parse a command line using short options only.

Provided for compatibility with PJ's Commandline class only.

Parameters:

args - the command line to be parsed

flagOptions - the short flag options allowed

flargOptions - the short flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

CommandLine

public CommandLine(java.lang.String[] args,
                   java.lang.String shortFlagOptions,
                   java.lang.String shortFlargOptions,
                   java.lang.String[] longFlagOptions,
                   java.lang.String[] longFlargOptions)
            throws CommandLine.ParseException

Parse a command line using the given short and options.

Provided for compatibility with PJ's Commandline class only.

Parameters:

args - the command line to be parsed

shortFlagOptions - the short flag options allowed

shortFlargOptions - the short flarg options allowed

longFlagOptions - the long flag options allowed

longFlargOptions - the long flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

CommandLine

public CommandLine(java.lang.String[] args,
                   java.lang.String flagOptions,
                   java.lang.String flargOptions,
                   java.lang.String argOptions)
            throws CommandLine.ParseException

Parse a command line using the given short options.

Parameters:

args - the command line to be parsed

flagOptions - the flag options allowed

flargOptions - the flarg options allowed

argOptions - the flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

CommandLine

public CommandLine(java.lang.String[] args,
                   java.util.List<java.lang.String> flagOptions,
                   java.util.List<java.lang.String> flargOptions,
                   java.util.List<java.lang.String> argOptions)
            throws CommandLine.ParseException

Parse a command line using the given options.

Parameters:

args - the command line to be parsed

flagOptions - the flag options allowed

flargOptions - the flarg options allowed

argOptions - the flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

Method Detail

optionStyle

public CommandLine.OptionStyle optionStyle()

Get the option style.

Returns:

the option style

validOptions

public CommandLine.ValidOptions validOptions()

Get the valid options.

Returns:

the valid options

parseResult

public CommandLine.ParseResult parseResult()

Get the parse result.

Returns:

the parse result

setCommandLine

public final void setCommandLine(java.lang.String[] args)

Set the command line.

Parameters:

args - the new command line

getCommandLine

public java.lang.String[] getCommandLine()

Get (a clone of) the command line.

Returns:

the current command line

parse

public final void parse()
                 throws CommandLine.ParseException

Parse the command line.

Throws:

CommandLine.ParseException - the command line is invalid