ikr.simlib.support.cmdline

Class ArgParser

java.lang.Object

ikr.simlib.support.cmdline.ArgParser

public class ArgParser
extends java.lang.Object

ArgParser gives support for command line parsing. Options use a hyphen and a single character and can take a number of arguments. The options -? and -h are predefined and should be used to print the usage via printUsage.

Constructor Summary

Constructors

Constructor and Description
ArgParser(java.lang.String name, java.lang.String usage) Constructs a new argument parser for the program.
ArgParser(java.lang.String name, java.lang.String usage, int args) Constructs a new argument parser for the program.
ArgParser(java.lang.String _name, java.lang.String _usage, int _minArgs, int _maxArgs) Constructs a new argument parser for the program.

Method Summary

Methods

Modifier and Type	Method and Description
ArgParser	addOption(char option) Adds an option without arguments to the parser.
ArgParser	addOption(char option, int numberOfArguments) Adds an option with exactly args arguments to the parser.
ArgParser	addOption(char option, int _minimumNumberOfArguments, int _maximumNumberOfArguments) Adds an option to the parser.
java.lang.String	getArgument()
java.lang.String	getArgument(char option)
java.lang.String	getArgument(char option, java.lang.String defaultValue)
java.lang.String	getArgument(java.lang.String defaultValue)
int	getArgumentCount()
int	getArgumentCount(char option)
java.util.List<java.lang.String>	getArguments()
java.util.List<java.lang.String>	getArguments(char option)
boolean	getBoolArgument()
boolean	getBoolArgument(boolean defaultValue)
boolean	getBoolArgument(char option)
boolean	getBoolArgument(char option, boolean defaultValue)
double	getDoubleArgument()
double	getDoubleArgument(char option)
double	getDoubleArgument(char option, double defaultValue)
double	getDoubleArgument(double defaultValue)
int	getIntArgument()
int	getIntArgument(char option)
int	getIntArgument(char option, int defaultValue)
int	getIntArgument(int defaultValue)
java.lang.String	getNthArgument(char option, int n)
java.lang.String	getNthArgument(int n)
boolean	getNthBoolArgument(char option, int n)
boolean	getNthBoolArgument(int n)
double	getNthDoubleArgument(char option, int n)
double	getNthDoubleArgument(int n)
int	getNthIntArgument(char option, int n)
int	getNthIntArgument(int n)
boolean	hasArgument(char option, int n) Returns whether a nth argument is available for an option or not.
boolean	hasArgument(int n) Returns whether a nth argument is available for the program or not.
boolean	hasArguments() Returns whether the program has arguments.
boolean	hasArguments(char option) Returns whether the option has arguments or is provided at all.
boolean	hasOption(char option)
boolean	parse(java.lang.String[] arguments) Parses the arguments.
boolean	parseSilent(java.lang.String[] arguments) Parses the arguments and returns whether an error or a help option occurred.
void	printError(java.io.PrintStream out, java.lang.String msg)
void	printError(java.lang.String msg)
void	printUsage()
void	printUsage(java.io.PrintStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgParser

public ArgParser(java.lang.String _name,
         java.lang.String _usage,
         int _minArgs,
         int _maxArgs)

Constructs a new argument parser for the program. The name and usage are used to provide the command line user with additional information.

Parameters:

_name - name of the program

_usage - usage text for the program

_minArgs - the minimum number of additional arguments

_maxArgs - the maximum number of additional arguments or -1 for no maximum.

ArgParser

public ArgParser(java.lang.String name,
         java.lang.String usage,
         int args)

Constructs a new argument parser for the program. The name and usage are used to provide the command line user with additional information.

Parameters:

name - name of the program

usage - usage text for the program

args - the number of required arguments

ArgParser

public ArgParser(java.lang.String name,
         java.lang.String usage)

Constructs a new argument parser for the program. The name and usage are used to provide the command line user with additional information. No additional arguments besides any options are allowed.

Parameters:

name - name of the program

usage - usage text for the program

Method Detail

parse

public boolean parse(java.lang.String[] arguments)

Parses the arguments. If either -h or -? is passed as argument the method will return true.

Returns:

whether a help option was provided

Throws:

ArgumentException - if any option/argument constraint has been broken.

See Also:

to prevent an exception to be thrown

parseSilent

public boolean parseSilent(java.lang.String[] arguments)

Parses the arguments and returns whether an error or a help option occurred.

printUsage

public void printUsage(java.io.PrintStream out)

printUsage

public void printUsage()

printError

public void printError(java.io.PrintStream out,
              java.lang.String msg)

printError

public void printError(java.lang.String msg)

addOption

public ArgParser addOption(char option,
                  int _minimumNumberOfArguments,
                  int _maximumNumberOfArguments)

Adds an option to the parser. The option might take any number of arguments as limited by minArgs and maxArgs.

Parameters:

_minimumNumberOfArguments - the minimum number of arguments for this option

_maximumNumberOfArguments - the maximum number of arguments for this option or -1 for no maximum.

Returns:

this

addOption

public ArgParser addOption(char option,
                  int numberOfArguments)

Adds an option with exactly args arguments to the parser.

Parameters:

option - the option character

numberOfArguments - the number of arguments for this option

Returns:

this

addOption

public ArgParser addOption(char option)

Adds an option without arguments to the parser.

Parameters:

option - the option character

Returns:

this

hasOption

public boolean hasOption(char option)

getArgumentCount

public int getArgumentCount()

getArgumentCount

public int getArgumentCount(char option)

hasArguments

public boolean hasArguments()

Returns whether the program has arguments.

hasArguments

public boolean hasArguments(char option)

Returns whether the option has arguments or is provided at all.

hasArgument

public boolean hasArgument(int n)

Returns whether a nth argument is available for the program or not.

hasArgument

public boolean hasArgument(char option,
                  int n)

Returns whether a nth argument is available for an option or not.

getArgument

public java.lang.String getArgument()

getArguments

public java.util.List<java.lang.String> getArguments()

getArgument

public java.lang.String getArgument(java.lang.String defaultValue)

getNthArgument

public java.lang.String getNthArgument(int n)

getArguments

public java.util.List<java.lang.String> getArguments(char option)

getArgument

public java.lang.String getArgument(char option)

getArgument

public java.lang.String getArgument(char option,
                           java.lang.String defaultValue)

getNthArgument

public java.lang.String getNthArgument(char option,
                              int n)

getIntArgument

public int getIntArgument()

getIntArgument

public int getIntArgument(int defaultValue)

getNthIntArgument

public int getNthIntArgument(int n)

getIntArgument

public int getIntArgument(char option)

getIntArgument

public int getIntArgument(char option,
                 int defaultValue)

getNthIntArgument

public int getNthIntArgument(char option,
                    int n)

getBoolArgument

public boolean getBoolArgument()

getBoolArgument

public boolean getBoolArgument(boolean defaultValue)

getNthBoolArgument

public boolean getNthBoolArgument(int n)

getBoolArgument

public boolean getBoolArgument(char option)

getBoolArgument

public boolean getBoolArgument(char option,
                      boolean defaultValue)

getNthBoolArgument

public boolean getNthBoolArgument(char option,
                         int n)

getDoubleArgument

public double getDoubleArgument()

getDoubleArgument

public double getDoubleArgument(double defaultValue)

getNthDoubleArgument

public double getNthDoubleArgument(int n)

getDoubleArgument

public double getDoubleArgument(char option)

getDoubleArgument

public double getDoubleArgument(char option,
                       double defaultValue)

getNthDoubleArgument

public double getNthDoubleArgument(char option,
                          int n)