digital.toke.azc

Class CmdLineParser

java.lang.Object

digital.toke.azc.CmdLineParser

public class CmdLineParser
extends Object

This is JArgs, written by Steve Purcell. Apparently a BSD style license. I could not seem to get the code out of Maven Central so it is packaged here. Largely GNU-compatible command-line options parser. Has short (-v) and long-form (--verbose) option support, and also allows options with associated values (-d 2, --debug 2, --debug=2). Option processing can be explicitly terminated by the argument '--'.

Version:

2.0

Author:

Steve Purcell, penSec.IT UG (haftungsbeschränkt)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmdLineParser.IllegalOptionValueException Thrown when an illegal or missing value is given by the user for an option that takes a value.
static class	CmdLineParser.NotFlagException Thrown when the parsed commandline contains multiple concatenated short options, such as -abcd, where one or more requires a value.
static class	CmdLineParser.Option<T> Representation of a command-line option
static class	CmdLineParser.OptionException Base class for exceptions that may be thrown when options are parsed
static class	CmdLineParser.UnknownOptionException Thrown when the parsed command-line contains an option that is not recognised.
static class	CmdLineParser.UnknownSuboptionException Thrown when the parsed commandline contains multiple concatenated short options, such as -abcd, where one is unknown.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,CmdLineParser.Option<?>>	options
private String[]	remainingArgs
private Map<String,List<?>>	values

Constructor Summary

Constructors

Constructor and Description
CmdLineParser()

Method Summary

Modifier and Type	Method and Description
CmdLineParser.Option<Boolean>	addBooleanOption(char shortForm, String longForm) Convenience method for adding a boolean option.
CmdLineParser.Option<Boolean>	addBooleanOption(String longForm) Convenience method for adding a boolean option.
CmdLineParser.Option<Double>	addDoubleOption(char shortForm, String longForm) Convenience method for adding a double option.
CmdLineParser.Option<Double>	addDoubleOption(String longForm) Convenience method for adding a double option.
CmdLineParser.Option<Integer>	addIntegerOption(char shortForm, String longForm) Convenience method for adding an integer option.
CmdLineParser.Option<Integer>	addIntegerOption(String longForm) Convenience method for adding an integer option.
CmdLineParser.Option<Long>	addLongOption(char shortForm, String longForm) Convenience method for adding a long integer option.
CmdLineParser.Option<Long>	addLongOption(String longForm) Convenience method for adding a long integer option.
<T> CmdLineParser.Option<T>	addOption(CmdLineParser.Option<T> opt) Add the specified Option to the list of accepted options
CmdLineParser.Option<String>	addStringOption(char shortForm, String longForm) Convenience method for adding a string option.
CmdLineParser.Option<String>	addStringOption(String longForm) Convenience method for adding a string option.
private <T> void	addValue(CmdLineParser.Option<T> opt, String valueArg, Locale locale)
<T> T	getOptionValue(CmdLineParser.Option<T> o) Equivalent to getOptionValue(o, null).
<T> T	getOptionValue(CmdLineParser.Option<T> o, T def)
<T> Collection<T>	getOptionValues(CmdLineParser.Option<T> option)
String[]	getRemainingArgs()
void	parse(String[] argv) Extract the options and non-option arguments from the given list of command-line arguments.
void	parse(String[] argv, Locale locale) Extract the options and non-option arguments from the given list of command-line arguments.

Methods inherited from class java.lang.Object

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

Field Detail

remainingArgs

private String[] remainingArgs

options

private Map<String,CmdLineParser.Option<?>> options

values

private Map<String,List<?>> values

Constructor Detail

CmdLineParser

public CmdLineParser()

Method Detail

addOption

public final <T> CmdLineParser.Option<T> addOption(CmdLineParser.Option<T> opt)

Add the specified Option to the list of accepted options

addStringOption

public final CmdLineParser.Option<String> addStringOption(char shortForm,
                                                          String longForm)

Convenience method for adding a string option.

Returns:

the new Option

addStringOption

public final CmdLineParser.Option<String> addStringOption(String longForm)

Convenience method for adding a string option.

Returns:

the new Option

addIntegerOption

public final CmdLineParser.Option<Integer> addIntegerOption(char shortForm,
                                                            String longForm)

Convenience method for adding an integer option.

Returns:

the new Option

addIntegerOption

public final CmdLineParser.Option<Integer> addIntegerOption(String longForm)

Convenience method for adding an integer option.

Returns:

the new Option

addLongOption

public final CmdLineParser.Option<Long> addLongOption(char shortForm,
                                                      String longForm)

Convenience method for adding a long integer option.

Returns:

the new Option

addLongOption

public final CmdLineParser.Option<Long> addLongOption(String longForm)

Convenience method for adding a long integer option.

Returns:

the new Option

addDoubleOption

public final CmdLineParser.Option<Double> addDoubleOption(char shortForm,
                                                          String longForm)

Convenience method for adding a double option.

Returns:

the new Option

addDoubleOption

public final CmdLineParser.Option<Double> addDoubleOption(String longForm)

Convenience method for adding a double option.

Returns:

the new Option

addBooleanOption

public final CmdLineParser.Option<Boolean> addBooleanOption(char shortForm,
                                                            String longForm)

Convenience method for adding a boolean option.

Returns:

the new Option

addBooleanOption

public final CmdLineParser.Option<Boolean> addBooleanOption(String longForm)

Convenience method for adding a boolean option.

Returns:

the new Option

getOptionValue

public final <T> T getOptionValue(CmdLineParser.Option<T> o)

Equivalent to getOptionValue(o, null).

getOptionValue

public final <T> T getOptionValue(CmdLineParser.Option<T> o,
                                  T def)

Returns:

the parsed value of the given Option, or the given default 'def' if the option was not set

getOptionValues

public final <T> Collection<T> getOptionValues(CmdLineParser.Option<T> option)

Returns:

A Collection giving the parsed values of all the occurrences of the given Option, or an empty Collection if the option was not set.

getRemainingArgs

public final String[] getRemainingArgs()

Returns:

the non-option arguments

parse

public final void parse(String[] argv)
                 throws CmdLineParser.OptionException

Extract the options and non-option arguments from the given list of command-line arguments. The default locale is used for parsing options whose values might be locale-specific.

Throws:

CmdLineParser.OptionException

parse

public final void parse(String[] argv,
                        Locale locale)
                 throws CmdLineParser.OptionException

Extract the options and non-option arguments from the given list of command-line arguments. The specified locale is used for parsing options whose values might be locale-specific.

Throws:

CmdLineParser.OptionException

addValue

private <T> void addValue(CmdLineParser.Option<T> opt,
                          String valueArg,
                          Locale locale)
                   throws CmdLineParser.IllegalOptionValueException

Throws:

CmdLineParser.IllegalOptionValueException