ca.uqac.lif.ecp.cli

Class CliParser

java.lang.Object

ca.uqac.lif.ecp.cli.CliParser

public class CliParser
extends java.lang.Object

A simple command-line parser

Version:

1.1

Author:

Sylvain Hallé

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CliParser.Argument Representation of a command line argument.
static class	CliParser.ArgumentMap

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<CliParser.Argument>	m_arguments

Constructor Summary

Constructors

Constructor and Description
CliParser()

Method Summary

Modifier and Type	Method and Description
void	addArgument(CliParser.Argument a) Adds a command-line argument to the parser
CliParser.ArgumentMap	parse(java.lang.String[] cli) Parses an array of command-line arguments and returns the result
void	printHelp(java.lang.String header, java.io.PrintStream out) Prints the usage of each command line switch

Methods inherited from class java.lang.Object

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

Field Detail

m_arguments

protected java.util.Set<CliParser.Argument> m_arguments

Constructor Detail

CliParser

public CliParser()

Method Detail

addArgument

public void addArgument(CliParser.Argument a)

Adds a command-line argument to the parser

Parameters:

a - The argument

parse

public CliParser.ArgumentMap parse(java.lang.String[] cli)

Parses an array of command-line arguments and returns the result

Parameters:

cli - The array of strings (typically, the args argument from main()

Returns:

A map from parameter's short names to their values, or null if the parsing failed

printHelp

public void printHelp(java.lang.String header,
                      java.io.PrintStream out)

Prints the usage of each command line switch

Parameters:

header - A string to display before the help

out - The print stream to send the output to (typically System.out or System.err