Alphabetical Index

A B C D G I J L M N O P S T U W

A

addBooleanOption(char,String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a boolean option.
addBooleanOption(String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a boolean option.
addDoubleOption(char,String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a double option.
addDoubleOption(String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a double option.
addIntegerOption(char,String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding an integer option.
addIntegerOption(String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding an integer option.
addLongOption(char,String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a long integer option.
addLongOption(String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a long integer option.
Add the specified Option to the list of accepted options
addStringOption(char,String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a string option.
addStringOption(String) - method in class jargs.gnu.CmdLineParser
Convenience method for adding a string option.
AllTests - class jargs.test.gnu.AllTests
AutoHelpParser - class jargs.examples.gnu.AutoHelpParser
This example shows how to dynamically create basic output for a --help option.

B

C

CmdLineParser - class jargs.gnu.CmdLineParser
Largely GNU-compatible command-line options parser.
CmdLineParserTestCase(String) - constructor for class jargs.test.gnu.CmdLineParserTestCase
CustomOptionTest - class jargs.examples.gnu.CustomOptionTest
CustomOptionTestCase(String) - constructor for class jargs.test.gnu.CustomOptionTestCase

D

An option that expects a floating-point value

G

Equivalent to getOptionValue(o, null).
getRemainingArgs() - method in class jargs.gnu.CmdLineParser
getValue(String,Locale) - method in class jargs.gnu.CmdLineParser.Option

I

Thrown when an illegal or missing value is given by the user for an option that takes a value.
An option that expects an integer value

J

jargs.gnu - package
jargs.test.gnu - package

L

longForm() - method in class jargs.gnu.CmdLineParser.Option
An option that expects a long integer value
LongOption(String) - constructor for class jargs.gnu.CmdLineParser.Option.LongOption

M

main(String[]) - static method in class jargs.examples.gnu.AutoHelpParser
main(String[]) - static method in class jargs.examples.gnu.CustomOptionTest
main(String[]) - static method in class jargs.examples.gnu.OptionParserSubclassTest
main(String[]) - static method in class jargs.examples.gnu.OptionTest

N

Thrown when the parsed commandline contains multiple concatenated short options, such as -abcd, where one or more requires a value.

O

Representation of a command-line option
Option(char,String,boolean) - constructor for class jargs.gnu.CmdLineParser.Option
Option(String,boolean) - constructor for class jargs.gnu.CmdLineParser.Option
Base class for exceptions that may be thrown when options are parsed
OptionTest - class jargs.examples.gnu.OptionTest

P

parse(String[]) - method in class jargs.gnu.CmdLineParser
Extract the options and non-option arguments from the given list of command-line arguments.
parse(String[],Locale) - method in class jargs.gnu.CmdLineParser
Extract the options and non-option arguments from the given list of command-line arguments.
Override to extract and convert an option value passed on the command-line
Override to extract and convert an option value passed on the command-line
Override to extract and convert an option value passed on the command-line
Override to extract and convert an option value passed on the command-line
Override to extract and convert an option value passed on the command-line
parseValue(String,Locale) - method in class jargs.examples.gnu.CustomOptionTest.ShortDateOption
Override to extract and convert an option value passed on the command-line
Override to extract and convert an option value passed on the command-line
printUsage() - method in class jargs.examples.gnu.AutoHelpParser

S

A custom type of command line option corresponding to a short date value, e.g.
ShortDateOption(char,String) - constructor for class jargs.examples.gnu.CustomOptionTest.ShortDateOption
shortForm() - method in class jargs.gnu.CmdLineParser.Option
An option that expects a string value
suite() - static method in class jargs.test.gnu.AllTests

T

testBadFormat() - method in class jargs.test.gnu.CmdLineParserTestCase
testCombinedFlags() - method in class jargs.test.gnu.CmdLineParserTestCase
testCustomOption() - method in class jargs.test.gnu.CustomOptionTestCase
testDefaults() - method in class jargs.test.gnu.CmdLineParserTestCase
testDetachedOption() - method in class jargs.test.gnu.CmdLineParserTestCase
testGetOptionValues() - method in class jargs.test.gnu.CmdLineParserTestCase
testIllegalCustomOption() - method in class jargs.test.gnu.CustomOptionTestCase
testLocale() - method in class jargs.test.gnu.CmdLineParserTestCase
testMultipleUses() - method in class jargs.test.gnu.CmdLineParserTestCase
testResetBetweenParse() - method in class jargs.test.gnu.CmdLineParserTestCase
testStandardOptions() - method in class jargs.test.gnu.CmdLineParserTestCase

U

Thrown when the parsed command-line contains an option that is not recognised.
Thrown when the parsed commandline contains multiple concatenated short options, such as -abcd, where one is unknown.

W

wantsValue() - method in class jargs.gnu.CmdLineParser.Option
Tells whether or not this option wants a value

Copyright © 2001-2003 Steve Purcell. Copyright © 2002 Vidar Holen. Copyright © 2002 Michal Ceresna. Copyright © 2005 Ewan Mellor. Released under the terms of the BSD licence.