org.stekikun.dolmen.cli

Class Args

java.lang.Object

org.stekikun.dolmen.cli.Args

public final class Args
extends Object

This class describes the various command-line arguments that can be used with the Dolmen CLI as an enumeration. This enumerations drives a generic command-line parsing implementation which is used by the CLI in Dolmen.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Args.ArgsParsingException A custom exception raised when encountering an error while parsing command-line arguments.
static class	Args.Type An enumeration type listing the different types of options that can be expected in the CLI.
static class	Args.Value Common variant type holding values associated to various types of command-line options.

Method Summary

Modifier and Type	Method and Description
List<String>	getExtras() Arguments are listed in order of appearance on the command line.
boolean	getFlag(org.stekikun.dolmen.cli.Args.Item item)
int	getNumeric(org.stekikun.dolmen.cli.Args.Item item)
String	getString(org.stekikun.dolmen.cli.Args.Item item)
static void	main(String[] args) An entry point for testing argument parsing only
static Args	parse(String[] args) Parses the given array of command-line arguments args according to the various available options described in Args.Item.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getFlag

public boolean getFlag(org.stekikun.dolmen.cli.Args.Item item)

Parameters:

item -

Returns:

the boolean value associated to the option item

Throws:

IllegalArgumentException - if item is not of type Args.Type.FLAG

getNumeric

public int getNumeric(org.stekikun.dolmen.cli.Args.Item item)

Parameters:

item -

Returns:

the numeric value associated to the option item

Throws:

IllegalArgumentException - if item is not of type Args.Type.NUMERIC

getString

public String getString(org.stekikun.dolmen.cli.Args.Item item)

Parameters:

item -

Returns:

the string value associated to the option item

Throws:

IllegalArgumentException - if item is not of type Args.Type.STRING

getExtras

public List<String> getExtras()

Arguments are listed in order of appearance on the command line.

Returns:

the list of extra arguments that were given on the command-line, i.e. arguments which were neither options nor option values

parse

public static Args parse(String[] args)
                  throws Args.ArgsParsingException

Parses the given array of command-line arguments args according to the various available options described in Args.Item.

The expected format of the command-line arguments is as follows:

• options are introduced with a double hyphen -- followed by their name, e.g. --name
• options may be available with a one-character short name as well, in which case they are introduced with a single hyphen, e.g. -n
• when an option expects a value of some type, the value must directly follow the option in the argument array; flag options require no value
• it is possible to use the short name notation to give more than one option at a time, e.g. -lah, provided all given options are flags
• stray arguments which are not associated to an option are taken as is and put in an extra arguments list.

Parameters:

args -

Returns:

an instance of Args which contains the result of the parsing of args

Throws:

Args.ArgsParsingException - if an error is encountered while parsing args

See Also:

getFlag(Item), getNumeric(Item), getString(Item), getExtras()

main

public static void main(String[] args)

An entry point for testing argument parsing only

Parameters:

args -