com.github.raphcal.argparser

Class ArgumentParser<T>

java.lang.Object

com.github.raphcal.argparser.ArgumentParser<T>

Type Parameters:

T - Type décrivant les arguments du programme.

public class ArgumentParser<T>
extends Object

Permet d'analyser les arguments donnés à un programme et d'afficher la liste des arguments attendus.

Author:

Raphaël Calabro (ddaeke-github@yahoo.fr)

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(Class<T> clazz) Creates a new parser for the given argument list class.

Method Summary

Modifier and Type	Method and Description
T	parse(String[] args) Parse the given program arguments and creates an instance of the argument list class.
void	printUsage(String appName, OutputStream outputStream) Prints the usage to the given output stream.
void	printUsage(String appName, Writer writer) Prints the usage to the given writer.
void	setLineLength(int lineLength) Change the line length for the usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentParser

public ArgumentParser(Class<T> clazz)

Creates a new parser for the given argument list class.

Parameters:

clazz - Class containing field annotated with Argument and/or Option anotations.

Method Detail

parse

public T parse(String[] args)

Parse the given program arguments and creates an instance of the argument list class.

If the number of required argument is not met, this method returns null.

Parameters:

args - Program arguments.

Returns:

A new instance of T or null if the parsing can't be completed.

setLineLength

public void setLineLength(int lineLength)

Change the line length for the usage.

Parameters:

lineLength - Line length of the terminal window.

printUsage

public void printUsage(String appName,
                       OutputStream outputStream)
                throws IOException

Prints the usage to the given output stream.

Parameters:

appName - Name of the application.

outputStream - Outputstream to use.

Throws:

IOException - If an error occurs while printing the usage.

printUsage

public void printUsage(String appName,
                       Writer writer)
                throws IOException

Prints the usage to the given writer.

Parameters:

appName - Name of the application.

writer - Writer to use.

Throws:

IOException - If an error occurs while printing the usage.