com.munkei

Class JArgP

java.lang.Object

com.munkei.JArgP

public class JArgP
extends Object

Since:

0.0.1

Author:

Theo 'Biffen' Willows

Constructor Summary

Constructors

Constructor and Description
JArgP(Object subject) Creates a JArgP object to use for parsing, etc.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	bold(String string) Make a string (ANSI) bold.
List<String>	parse(String[] args) Parses command line arguments and sets the values to the subject.
void	printUsage() Like #printUsage(Stream output), but prints to System.out.
void	printUsage(PrintStream output) Prints the usage text, based on the description and default annotation elements and the usage header.
void	setUsageHeader(String usageHeader) Sets the text to be shown at the beginning of the usage text.
protected static String	underline(String string) Make a string (ANSI) underlined.

Methods inherited from class java.lang.Object

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

Constructor Detail

JArgP

public JArgP(Object subject)
      throws NullPointerException

Creates a JArgP object to use for parsing, etc.

Parameters:

subject - The Object that has the annotated members.

Throws:

NullPointerException

Method Detail

bold

protected static String bold(String string)

Make a string (ANSI) bold.

Parameters:

string - The string.

Returns:

The bold string.

underline

protected static String underline(String string)

Make a string (ANSI) underlined.

Parameters:

string - The string.

Returns:

The underlined string.

parse

public List<String> parse(String[] args)
                   throws NullPointerException,
                          NoSuchOptionException,
                          ArgumentParsingException

Parses command line arguments and sets the values to the subject.

Parameters:

args - The command line arguments.

Returns:

A list of the remaining parameters (i.e. arguments that are not options of values of options).

Throws:

NullPointerException - If args is null.

NoSuchOptionException - If an option is encountered that is not configured.

ArgumentParsingException - If something goes wrong with the parsing or setting of parameters.

setUsageHeader

public void setUsageHeader(String usageHeader)

Sets the text to be shown at the beginning of the usage text.

Parameters:

usageHeader - The header text.

See Also:

printUsage(java.io.PrintStream)

printUsage

public void printUsage(PrintStream output)
                throws NullPointerException

Prints the usage text, based on the description and default annotation elements and the usage header.

Parameters:

output - The target for printing.

Throws:

NullPointerException - If output is null.

See Also:

setUsageHeader(java.lang.String), printUsage()

printUsage

public void printUsage()

Like #printUsage(Stream output), but prints to System.out.