joshua.util.CommandLineParser Class Reference

Collaboration diagram for joshua.util.CommandLineParser:

List of all members.

Classes
class	CommandLineParserException
class	DuplicateOptionException
class	Option< OptionType >
class	UniversalSet< E >
Public Member Functions
	CommandLineParser ()
	CommandLineParser (Set< String > localizedTrueStrings, Set< String > localizedFalseStrings)
Option< Integer >	addIntegerOption (char shortForm, String longForm, String valueVariable, Integer defaultValue, Set< Integer > legalValues, String comment)
Option< Integer >	addIntegerOption (char shortForm, String longForm, String valueVariable, Set< Integer > legalValues, String comment)
Option< Integer >	addIntegerOption (char shortForm, String longForm, String valueVariable, String comment)
Option< Integer >	addIntegerOption (char shortForm, String longForm, String comment)
Option< Integer >	addIntegerOption (char shortForm, String longForm, String valueVariable, Integer defaultValue, String comment)
Option< Integer >	addIntegerOption (String longForm, String valueVariable, Integer defaultValue, String comment)
Option< Integer >	addIntegerOption (char shortForm, String longForm)
Option< Integer >	addIntegerOption (char shortForm)
Option< Integer >	addIntegerOption (String longForm)
Option< Integer >	addIntegerOption (String longForm, String comment)
Option< String >	addStringOption (char shortForm, String longForm, String valueVariable, String defaultValue, Set< String > legalValues, String comment)
Option< String >	addStringOption (char shortForm, String longForm, String valueVariable, Set< String > legalValues, String comment)
Option< String >	addStringOption (char shortForm, String longForm, String valueVariable, String comment)
Option< String >	addStringOption (String longForm, String valueVariable, String comment)
Option< String >	addStringOption (char shortForm, String longForm, String comment)
Option< String >	addStringOption (char shortForm, String longForm, String valueVariable, String defaultValue, String comment)
Option< String >	addStringOption (String longForm, String valueVariable, String defaultValue, String comment)
Option< String >	addStringOption (char shortForm, String longForm)
Option< String >	addStringOption (char shortForm)
Option< String >	addStringOption (String longForm)
Option< String >	addStringOption (String longForm, String comment)
Option< Boolean >	addBooleanOption (char shortForm, String longForm, String valueVariable, Boolean defaultValue, String comment)
Option< Boolean >	addBooleanOption (char shortForm, String longForm, String valueVariable, String comment)
Option< Boolean >	addBooleanOption (char shortForm, String longForm, String comment)
Option< Boolean >	addBooleanOption (String longForm, Boolean defaultValue, String comment)
Option< Boolean >	addBooleanOption (String longForm, String valueVariable, Boolean defaultValue, String comment)
Option< Boolean >	addBooleanOption (char shortForm, String longForm)
Option< Boolean >	addBooleanOption (char shortForm)
Option< Boolean >	addBooleanOption (String longForm)
Option< Boolean >	addBooleanOption (String longForm, String comment)
void	parse (String[] argv)
void	printUsage ()
Option	parseLongForm (String key, String value)
Option	parseLongForm (String key)
Option	parseShortForm (Character key)
Option	parseShortForm (Character key, String value)
boolean	hasValue (Option<?> option)
Static Public Member Functions
static void	main (String[] args)
Package Functions
public< OptionType > OptionType	getValue (Option< OptionType > option)
Private Member Functions
void	die (String error)
Private Attributes
Map< Character, Option< Integer > >	intShortForms
Map< String, Option< Integer > >	intLongForms
Map< Character, Option< String > >	stringShortForms
Map< String, Option< String > >	stringLongForms
Map< Character, Option< Boolean > >	booleanShortForms
Map< String, Option< Boolean > >	booleanLongForms
List< Option >	allOptions
final Set< String >	localizedTrueStrings = new HashSet<String>()
final Set< String >	localizedFalseStrings = new HashSet<String>()

---

Detailed Description

Java Command Line Parser

The current version supports string and integer options.

Support is not included for options which take a list of values.

Author:

Lane O.B. Schwartz

Version:

$LastChangedDate$

---

Constructor & Destructor Documentation

joshua.util.CommandLineParser.CommandLineParser

(

)

joshua.util.CommandLineParser.CommandLineParser	(	Set< String >	localizedTrueStrings,
		Set< String >	localizedFalseStrings
	)

---

Member Function Documentation

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		Boolean	defaultValue,
		String	comment
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		String	comment
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	char	shortForm,
		String	longForm,
		String	comment
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	String	longForm,
		Boolean	defaultValue,
		String	comment
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	String	longForm,
		String	valueVariable,
		Boolean	defaultValue,
		String	comment
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	char	shortForm,
		String	longForm
	)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption

(

char

shortForm

)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption

(

String

longForm

)

Option<Boolean> joshua.util.CommandLineParser.addBooleanOption	(	String	longForm,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		Integer	defaultValue,
		Set< Integer >	legalValues,
		String	comment
	)

Here is the caller graph for this function:

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		Set< Integer >	legalValues,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		Integer	defaultValue,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	String	longForm,
		String	valueVariable,
		Integer	defaultValue,
		String	comment
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	char	shortForm,
		String	longForm
	)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption

(

char

shortForm

)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption

(

String

longForm

)

Option<Integer> joshua.util.CommandLineParser.addIntegerOption	(	String	longForm,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		String	defaultValue,
		Set< String >	legalValues,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		Set< String >	legalValues,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	String	longForm,
		String	valueVariable,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm,
		String	valueVariable,
		String	defaultValue,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	String	longForm,
		String	valueVariable,
		String	defaultValue,
		String	comment
	)

Option<String> joshua.util.CommandLineParser.addStringOption	(	char	shortForm,
		String	longForm
	)

Option<String> joshua.util.CommandLineParser.addStringOption

(

char

shortForm

)

Option<String> joshua.util.CommandLineParser.addStringOption

(

String

longForm

)

Option<String> joshua.util.CommandLineParser.addStringOption	(	String	longForm,
		String	comment
	)

void joshua.util.CommandLineParser.die

(

String

error

)

[private]

public<OptionType> OptionType joshua.util.CommandLineParser.getValue

(

Option< OptionType >

option

)

[package]

Here is the call graph for this function:

Here is the caller graph for this function:

boolean joshua.util.CommandLineParser.hasValue

(

Option<?>

option

)

static void joshua.util.CommandLineParser.main

(

String[]

args

)

[static]

Here is the call graph for this function:

void joshua.util.CommandLineParser.parse

(

String[]

argv

)

Here is the caller graph for this function:

Option joshua.util.CommandLineParser.parseLongForm	(	String	key,
		String	value
	)

Option joshua.util.CommandLineParser.parseLongForm

(

String

key

)

Option joshua.util.CommandLineParser.parseShortForm

(

Character

key

)

Option joshua.util.CommandLineParser.parseShortForm	(	Character	key,
		String	value
	)

void joshua.util.CommandLineParser.printUsage

(

)

---

Member Data Documentation

List<Option> joshua.util.CommandLineParser.allOptions [private]

Map<String, Option<Boolean> > joshua.util.CommandLineParser.booleanLongForms [private]

Map<Character, Option<Boolean> > joshua.util.CommandLineParser.booleanShortForms [private]

Map<String, Option<Integer> > joshua.util.CommandLineParser.intLongForms [private]

Map<Character, Option<Integer> > joshua.util.CommandLineParser.intShortForms [private]

final Set<String> joshua.util.CommandLineParser.localizedFalseStrings = new HashSet<String>() [private]

final Set<String> joshua.util.CommandLineParser.localizedTrueStrings = new HashSet<String>() [private]

Map<String, Option<String> > joshua.util.CommandLineParser.stringLongForms [private]

Map<Character, Option<String> > joshua.util.CommandLineParser.stringShortForms [private]