fr.inria.opengve.tools
Class CommandLineParse

java.lang.Object
  fr.inria.opengve.tools.CommandLineParse

public class CommandLineParse
extends java.lang.Object

This class provide an easy way to parse the command line arguments of a program. The use of this class is divided in three parts :

Object creation

CommandLineParse parser = new CommandLineParse(args);

Parameters definition

After parser creation, all possibles parameters must be define in the parser. There is five types for parameters (boolean, integer, long, double and string). Parameters can be define with default value (except boolean parameters) and as a sub option of an already defined option.

Author:

fabrice.peix@sophia.inria.fr

Nested Class Summary

class	CommandLineParse.BooleanParameter
class	CommandLineParse.CommandLineParserException Exception throwed for all errors find during the command line parsing.
class	CommandLineParse.DoubleParameter
class	CommandLineParse.IntegerParameter
class	CommandLineParse.LongParameter
static class	CommandLineParse.OptionType Enumeration of all option type.
class	CommandLineParse.StringParameter

Constructor Summary

CommandLineParse(java.lang.String[] args)
Constructor of the parser.

Method Summary

CommandLineParse.BooleanParameter	declareBooleanParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter) Declare a boolean parameter as a sub parameter of a given parameter.
CommandLineParse.BooleanParameter	declareBooleanParameter(java.lang.String shortParameter, java.lang.String longParameter) Declare a boolean parameter.
CommandLineParse.DoubleParameter	declareDoubleParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a double parameter.
CommandLineParse.DoubleParameter	declareDoubleParameter(java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a double parameter.
CommandLineParse.DoubleParameter	declareDoubleParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, double defaultValue) Declare a double parameter with a default value.
CommandLineParse.DoubleParameter	declareDoubleParameterWithDefaultValue(java.lang.String shortParameter, java.lang.String longParameter, double defaultValue) Declare a double parameter with a default value.
CommandLineParse.BooleanParameter	declareHelpParameter() This methods declare the special Help parameter his shortName is -h and his longName is --help.
CommandLineParse.IntegerParameter	declareIntegerParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare an integer parameter with a given super parameter.
CommandLineParse.IntegerParameter	declareIntegerParameter(java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a integer parameter.
CommandLineParse.IntegerParameter	declareIntegerParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, int defaultValue) Declare an integer parameter with a default value and a given super parameter.
CommandLineParse.IntegerParameter	declareIntegerParameterWithDefaultValue(java.lang.String shortParameter, java.lang.String longParameter, int defaultValue) Declare a integer parameter with a default value.
CommandLineParse.LongParameter	declareLongParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a long parameter with a given super parameter.
CommandLineParse.LongParameter	declareLongParameter(java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a long parameter.
CommandLineParse.LongParameter	declareLongParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superOption, java.lang.String shortOption, java.lang.String longOption, long defaultValue) Declare a long parameter with a default value.
CommandLineParse.LongParameter	declareLongParameterWithDefaultValue(java.lang.String shortParameter, java.lang.String longParameter, long defaultValue) Declare a long parameter with a default value.
CommandLineParse.StringParameter	declareStringParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter) Declare a String parameter with a given super parameter.
CommandLineParse.StringParameter	declareStringParameter(java.lang.String shortParameter, java.lang.String longParameter, boolean mustBePresent) Declare a String parameter.
CommandLineParse.StringParameter	declareStringParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter, java.lang.String shortParameter, java.lang.String longParameter, java.lang.String defaultValue) Add a String parameter with a default value and a super parameter.
CommandLineParse.StringParameter	declareStringParameterWithDefaultValue(java.lang.String shortParameter, java.lang.String longParameter, java.lang.String defaultValue) Add a String parameter.
java.lang.String[]	getNotProceedArgs() After the call to parse give the array of arguments that are not reconize as parameters.
void	parse() Parse the command line.
java.lang.String	usage() Return the string representing the usage of the different parameter define in this parser.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineParse

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

Constructor of the parser.

Parameters:

args - The array containing the command line option.

Method Detail

parse

public void parse()

Parse the command line.

declareHelpParameter

public CommandLineParse.BooleanParameter declareHelpParameter()

This methods declare the special Help parameter his shortName is -h and his longName is --help. When this option is present the parser don't throw exeption if all required options are not present.

Returns:

The boolean option corresponding to help.

declareBooleanParameter

public CommandLineParse.BooleanParameter declareBooleanParameter(java.lang.String shortParameter,
                                                                 java.lang.String longParameter)

Declare a boolean parameter. Note that this parameter have always a default value equal to false

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

Returns:

The parameter added to the parser.

declareBooleanParameter

public CommandLineParse.BooleanParameter declareBooleanParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                                 java.lang.String shortParameter,
                                                                 java.lang.String longParameter)

Declare a boolean parameter as a sub parameter of a given parameter. Note that this parameter have always a default value equal to false

Parameters:

superParameter - The super parameter of the new boolean parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

Returns:

The parameter added to the parser.

declareIntegerParameter

public CommandLineParse.IntegerParameter declareIntegerParameter(java.lang.String shortParameter,
                                                                 java.lang.String longParameter,
                                                                 boolean mustBePresent)

Declare a integer parameter.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareIntegerParameterWithDefaultValue

public CommandLineParse.IntegerParameter declareIntegerParameterWithDefaultValue(java.lang.String shortParameter,
                                                                                 java.lang.String longParameter,
                                                                                 int defaultValue)

Declare a integer parameter with a default value.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareIntegerParameter

public CommandLineParse.IntegerParameter declareIntegerParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                                 java.lang.String shortParameter,
                                                                 java.lang.String longParameter,
                                                                 boolean mustBePresent)

Declare an integer parameter with a given super parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareIntegerParameterWithDefaultValue

public CommandLineParse.IntegerParameter declareIntegerParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                                                 java.lang.String shortParameter,
                                                                                 java.lang.String longParameter,
                                                                                 int defaultValue)

Declare an integer parameter with a default value and a given super parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareLongParameter

public CommandLineParse.LongParameter declareLongParameter(java.lang.String shortParameter,
                                                           java.lang.String longParameter,
                                                           boolean mustBePresent)

Declare a long parameter.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareLongParameterWithDefaultValue

public CommandLineParse.LongParameter declareLongParameterWithDefaultValue(java.lang.String shortParameter,
                                                                           java.lang.String longParameter,
                                                                           long defaultValue)

Declare a long parameter with a default value.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareLongParameter

public CommandLineParse.LongParameter declareLongParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                           java.lang.String shortParameter,
                                                           java.lang.String longParameter,
                                                           boolean mustBePresent)

Declare a long parameter with a given super parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareLongParameterWithDefaultValue

public CommandLineParse.LongParameter declareLongParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superOption,
                                                                           java.lang.String shortOption,
                                                                           java.lang.String longOption,
                                                                           long defaultValue)

Declare a long parameter with a default value.

Parameters:

superOption - The super parameter of the new parameter.

shortOption - The short form of the parameter.

longOption - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareDoubleParameter

public CommandLineParse.DoubleParameter declareDoubleParameter(java.lang.String shortParameter,
                                                               java.lang.String longParameter,
                                                               boolean mustBePresent)

Declare a double parameter.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareDoubleParameterWithDefaultValue

public CommandLineParse.DoubleParameter declareDoubleParameterWithDefaultValue(java.lang.String shortParameter,
                                                                               java.lang.String longParameter,
                                                                               double defaultValue)

Declare a double parameter with a default value.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareDoubleParameter

public CommandLineParse.DoubleParameter declareDoubleParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                               java.lang.String shortParameter,
                                                               java.lang.String longParameter,
                                                               boolean mustBePresent)

Declare a double parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareDoubleParameterWithDefaultValue

public CommandLineParse.DoubleParameter declareDoubleParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                                               java.lang.String shortParameter,
                                                                               java.lang.String longParameter,
                                                                               double defaultValue)

Declare a double parameter with a default value.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareStringParameter

public CommandLineParse.StringParameter declareStringParameter(java.lang.String shortParameter,
                                                               java.lang.String longParameter,
                                                               boolean mustBePresent)

Declare a String parameter.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

mustBePresent - Say if the parameter must be specified.

Returns:

The parameter added to the parser.

declareStringParameterWithDefaultValue

public CommandLineParse.StringParameter declareStringParameterWithDefaultValue(java.lang.String shortParameter,
                                                                               java.lang.String longParameter,
                                                                               java.lang.String defaultValue)

Add a String parameter.

Parameters:

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

declareStringParameter

public CommandLineParse.StringParameter declareStringParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                               java.lang.String shortParameter,
                                                               java.lang.String longParameter)

Declare a String parameter with a given super parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

Returns:

The parameter added to the parser.

declareStringParameterWithDefaultValue

public CommandLineParse.StringParameter declareStringParameterWithDefaultValue(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter superParameter,
                                                                               java.lang.String shortParameter,
                                                                               java.lang.String longParameter,
                                                                               java.lang.String defaultValue)

Add a String parameter with a default value and a super parameter.

Parameters:

superParameter - The super parameter of the new parameter.

shortParameter - The short form of the parameter.

longParameter - The long form of the parameter.

defaultValue - The default value of this parameter.

Returns:

The parameter added to the parser.

usage

public java.lang.String usage()

Return the string representing the usage of the different parameter define in this parser.

Returns:

A string.

getNotProceedArgs

public java.lang.String[] getNotProceedArgs()

After the call to parse give the array of arguments that are not reconize as parameters.

Returns:

The array of arguments that are not reconize as parameters.