A B D G I L M N O P S

A

add(Option) - Method in class org.freehep.util.argv.ArgumentParser

Add a new option to be taken into consideration during the next parse.

add(Parameter) - Method in class org.freehep.util.argv.ArgumentParser

ArgumentFormatException - Exception in org.freehep.util.argv

ArgumentFormatException(String) - Constructor for exception org.freehep.util.argv.ArgumentFormatException

ArgumentParser - Class in org.freehep.util.argv

A parser for processing command line arguments.

ArgumentParser(String) - Constructor for class org.freehep.util.argv.ArgumentParser

B

BailOutException - Exception in org.freehep.util.argv

Exception to handle options such as -version or -help which need to bail out from the parsing loop.

BailOutException() - Constructor for exception org.freehep.util.argv.BailOutException

BooleanOption - Class in org.freehep.util.argv

A Boolean option for use with ArgumentParser.

BooleanOption(String, String) - Constructor for class org.freehep.util.argv.BooleanOption

BooleanOption(String, String, boolean) - Constructor for class org.freehep.util.argv.BooleanOption

BooleanOption(String, String, String) - Constructor for class org.freehep.util.argv.BooleanOption

BooleanOption(String, String, String, boolean) - Constructor for class org.freehep.util.argv.BooleanOption

D

DoubleOption - Class in org.freehep.util.argv

DoubleOption(String, String, String) - Constructor for class org.freehep.util.argv.DoubleOption

DoubleOption(String, String, String, String) - Constructor for class org.freehep.util.argv.DoubleOption

DoubleOption(String, String, double, String) - Constructor for class org.freehep.util.argv.DoubleOption

DoubleOption(String, String, String, double, String) - Constructor for class org.freehep.util.argv.DoubleOption

DoubleParameter - Class in org.freehep.util.argv

DoubleParameter(String, String) - Constructor for class org.freehep.util.argv.DoubleParameter

G

getDestination() - Method in class org.freehep.util.argv.PairOption

Return the destination value of this argument, which may be null.

getDouble() - Method in class org.freehep.util.argv.DoubleOption

getDouble() - Method in class org.freehep.util.argv.DoubleParameter

getInt() - Method in class org.freehep.util.argv.IntOption

getInt() - Method in class org.freehep.util.argv.IntParameter

getName() - Method in class org.freehep.util.argv.ListParameter

getName() - Method in class org.freehep.util.argv.NumberParameter

getName() - Method in interface org.freehep.util.argv.Parameter

Must return name of the parameter.

getName() - Method in class org.freehep.util.argv.StringParameter

getOption() - Method in class org.freehep.util.argv.BooleanOption

getOption() - Method in class org.freehep.util.argv.MultiStringOption

getOption() - Method in class org.freehep.util.argv.NumberOption

getOption() - Method in interface org.freehep.util.argv.Option

Must return the flag and parameters of this option.

getOption() - Method in class org.freehep.util.argv.PairOption

getOption() - Method in class org.freehep.util.argv.StringOption

getSource() - Method in class org.freehep.util.argv.PairOption

Return the source value of this argument, which may be null.

getUsage() - Method in class org.freehep.util.argv.BooleanOption

getUsage() - Method in class org.freehep.util.argv.ListParameter

Usage method invoked by ArgumentParser.

getUsage() - Method in class org.freehep.util.argv.MultiStringOption

getUsage() - Method in class org.freehep.util.argv.NumberOption

getUsage() - Method in class org.freehep.util.argv.NumberParameter

Usage method invoked by ArgumentParser.

getUsage() - Method in interface org.freehep.util.argv.Option

Must return a description of the usage of this option.

getUsage() - Method in class org.freehep.util.argv.PairOption

getUsage() - Method in interface org.freehep.util.argv.Parameter

Must return a description of the usage of this parameter.

getUsage() - Method in class org.freehep.util.argv.StringOption

getUsage() - Method in class org.freehep.util.argv.StringParameter

Usage method invoked by ArgumentParser.

getValue() - Method in class org.freehep.util.argv.BooleanOption

Returns the boolean value of this option.

getValue() - Method in class org.freehep.util.argv.ListParameter

Returns the list of values collected by this parameter.

getValue() - Method in class org.freehep.util.argv.MultiStringOption

getValue() - Method in class org.freehep.util.argv.NumberOption

Return the value of this argument, which may be null.

getValue() - Method in class org.freehep.util.argv.NumberParameter

Return the value of this argument, which may be null.

getValue() - Method in class org.freehep.util.argv.StringOption

Return the string value of this argument, which may be null.

getValue() - Method in class org.freehep.util.argv.StringParameter

Return the string value of this argument, which may be null.

I

IntOption - Class in org.freehep.util.argv

IntOption(String, String, String) - Constructor for class org.freehep.util.argv.IntOption

IntOption(String, String, String, String) - Constructor for class org.freehep.util.argv.IntOption

IntOption(String, String, int, String) - Constructor for class org.freehep.util.argv.IntOption

IntOption(String, String, String, int, String) - Constructor for class org.freehep.util.argv.IntOption

IntParameter - Class in org.freehep.util.argv

IntParameter(String, String) - Constructor for class org.freehep.util.argv.IntParameter

L

ListParameter - Class in org.freehep.util.argv

A List parameter for use with ArgumentParser.

ListParameter(String, String) - Constructor for class org.freehep.util.argv.ListParameter

Initialize a new List parameter with the given description.

M

main(String[]) - Static method in class org.freehep.util.argv.ArgumentParser

Test driver.

MissingArgumentException - Exception in org.freehep.util.argv

MissingArgumentException(String) - Constructor for exception org.freehep.util.argv.MissingArgumentException

MultiStringOption - Class in org.freehep.util.argv

A Multiple String option for use with ArgumentParser.

MultiStringOption(String, String, String) - Constructor for class org.freehep.util.argv.MultiStringOption

MultiStringOption(String, String, String, String) - Constructor for class org.freehep.util.argv.MultiStringOption

N

NumberOption - Class in org.freehep.util.argv

A Number option for use with ArgumentParser.

NumberOption(String, String, String) - Constructor for class org.freehep.util.argv.NumberOption

NumberOption(String, String, String, String) - Constructor for class org.freehep.util.argv.NumberOption

NumberOption(String, String, BigDecimal, String) - Constructor for class org.freehep.util.argv.NumberOption

NumberOption(String, String, String, BigDecimal, String) - Constructor for class org.freehep.util.argv.NumberOption

NumberParameter - Class in org.freehep.util.argv

A Number Parameter for use with ArgumentParser.

NumberParameter(String, String) - Constructor for class org.freehep.util.argv.NumberParameter

Initialize a new Number parameter.

O

Option - Interface in org.freehep.util.argv

Interface for options that may be registered and parsed by the ArgumentParser.

org.freehep.util.argv - package org.freehep.util.argv

P

PairOption - Class in org.freehep.util.argv

A Pair option for use with ArgumentParser.

PairOption(String, String, String, String) - Constructor for class org.freehep.util.argv.PairOption

Initialize a new Pair argument.

PairOption(String, String, String, String, String) - Constructor for class org.freehep.util.argv.PairOption

Parameter - Interface in org.freehep.util.argv

Interface for parameters that may be registered and parsed by the ArgumentParser.

parse(String[]) - Method in class org.freehep.util.argv.ArgumentParser

Parses the given argument list according to all Options registered with this parser.

parse(List) - Method in class org.freehep.util.argv.ArgumentParser

Parses the given argument list according to all Options registered with this parser.

parse(List) - Method in class org.freehep.util.argv.BooleanOption

Parsing method invoked by ArgumentParser.

parse(List) - Method in class org.freehep.util.argv.ListParameter

Parsing method invoked by ArgumentParser.

parse(List) - Method in class org.freehep.util.argv.MultiStringOption

parse(List) - Method in class org.freehep.util.argv.NumberOption

Parsing method invoked by ArgumentParser.

parse(List) - Method in class org.freehep.util.argv.NumberParameter

Parsing method invoked by ArgumentParser.

parse(List) - Method in interface org.freehep.util.argv.Option

Must check whether values begins with this option.

parse(List) - Method in class org.freehep.util.argv.PairOption

Parsing method invoked by ArgumentParser.

parse(List) - Method in interface org.freehep.util.argv.Parameter

Must check for a parameter.

parse(List) - Method in class org.freehep.util.argv.StringOption

Parsing method invoked by ArgumentParser.

parse(List) - Method in class org.freehep.util.argv.StringParameter

Parsing method invoked by ArgumentParser.

printUsage(OutputStream) - Method in class org.freehep.util.argv.ArgumentParser

Dumps the usage of the program and each parameter and option to out.

S

StringOption - Class in org.freehep.util.argv

A String option for use with ArgumentParser.

StringOption(String, String, String) - Constructor for class org.freehep.util.argv.StringOption

Initialize a new String argument with the given flag and description but without a default value.

StringOption(String, String, String, String) - Constructor for class org.freehep.util.argv.StringOption

StringOption(String, String, String, String, String) - Constructor for class org.freehep.util.argv.StringOption

StringOption(String, String, String, String, String, boolean) - Constructor for class org.freehep.util.argv.StringOption

StringParameter - Class in org.freehep.util.argv

A String parameter for use with ArgumentParser.

StringParameter(String, String) - Constructor for class org.freehep.util.argv.StringParameter

Initialize a new String argument with the given flag and description but without a default value.

A B D G I L M N O P S