A C D E F G I J M N O P S X

A

And - class org.jcommando.And.

And() - Constructor for class org.jcommando.And

addCommand(Command) - Method in class org.jcommando.JCommandParser

addOption(Option) - Method in class org.jcommando.Command

Add an option to the set of options supported by this command.

addOption(Option) - Method in class org.jcommando.Grouping

Add an option to this grouping.

addOption(Option) - Method in class org.jcommando.JCommandParser

C

Command - class org.jcommando.Command.

Command() - Constructor for class org.jcommando.Command

Constructs an object representing a command and it's required and optional "Options".

characters(char[], int, int) - Method in class org.jcommando.SAXHandler

Overloaded method.

commands - Variable in class org.jcommando.JCommandParser

commandsById - Variable in class org.jcommando.JCommandParser

D

doGenerate() - Method in class org.jcommando.GeneratedParser

Called by parser to perform the 'generate' command.

doGenerate() - Method in class org.jcommando.JCommandoGen

Generate a parser from an XML command file.

E

endDocument() - Method in class org.jcommando.SAXHandler

This method is called by the SAX parser when the end of document is reached.

endElement(String, String, String) - Method in class org.jcommando.SAXHandler

Overloaded method.

execute() - Method in class org.jcommando.ant.JCommando

Executes the ant task.

F

fatalError(SAXParseException) - Method in class org.jcommando.SAXHandler

Overloaded method.

G

GeneratedParser - class org.jcommando.GeneratedParser.

JCommando generated parser class.

GeneratedParser() - Constructor for class org.jcommando.GeneratedParser

JCommando generated constructor.

Grouping - class org.jcommando.Grouping.

Grouping() - Constructor for class org.jcommando.Grouping

Default constructor.

getClassName() - Method in class org.jcommando.JCommandoGen

getDescription() - Method in class org.jcommando.Command

getDescription() - Method in class org.jcommando.Option

Get the textual description of this option.

getDestDir() - Method in class org.jcommando.JCommandoGen

getGrouping() - Method in class org.jcommando.Command

getGroupings() - Method in class org.jcommando.Grouping

Get the child "Groupings" of this Grouping.

getId() - Method in class org.jcommando.Command

getId() - Method in class org.jcommando.Option

Get the unique identifier for this option.

getInputFile() - Method in class org.jcommando.JCommandoGen

getLongMnemonic() - Method in class org.jcommando.Option

Get the long form of this option.

getMax() - Method in class org.jcommando.Option

Get the maximum valid value of this option.

getMin() - Method in class org.jcommando.Option

Get the minumum valid value of this option.

getName() - Method in class org.jcommando.Command

getOptionById(String) - Method in class org.jcommando.JCommandParser

Get the option with the specified id.

getOptionType() - Method in class org.jcommando.Option

Get the Java type of this option.

getOptions() - Method in class org.jcommando.Grouping

Get the options in this Grouping.

getPackageName() - Method in class org.jcommando.JCommandoGen

getShortMnemonic() - Method in class org.jcommando.Option

Get the short form of this option.

groupings - Variable in class org.jcommando.Grouping

I

id - Variable in class org.jcommando.Grouping

isAllowOptionless() - Method in class org.jcommando.Command

Determines whether this command will be executed even if there are no options specified.

J

JCommandParser - class org.jcommando.JCommandParser.

JCommandParser() - Constructor for class org.jcommando.JCommandParser

JCommando - class org.jcommando.ant.JCommando.

JCommando() - Constructor for class org.jcommando.ant.JCommando

Task constructor.

JCommandoGen - class org.jcommando.JCommandoGen.

This class generates a command parser based on an XML input file.

JCommandoGen() - Constructor for class org.jcommando.JCommandoGen

Empty constructor.

M

main(String[]) - Static method in class org.jcommando.JCommandoGen

The "main" that generates the command parser.

N

Not - class org.jcommando.Not.

Not() - Constructor for class org.jcommando.Not

O

Option - class org.jcommando.Option.

This class encapsulates the state of an 'option' specified in a JCommando XML file.

Option() - Constructor for class org.jcommando.Option

Default constructor.

Or - class org.jcommando.Or.

Or() - Constructor for class org.jcommando.Or

options - Variable in class org.jcommando.Grouping

optionsById - Variable in class org.jcommando.JCommandParser

optionsByLong - Variable in class org.jcommando.JCommandParser

optionsByShort - Variable in class org.jcommando.JCommandParser

org.jcommando - package org.jcommando

org.jcommando.ant - package org.jcommando.ant

P

ParseException - exception org.jcommando.ParseException.

ParseException(String) - Constructor for class org.jcommando.ParseException

Throw a parse exception with the supplied message.

ParseException(String, Throwable) - Constructor for class org.jcommando.ParseException

Throw a parse exception the the supplied message and throwable.

parse(String[]) - Method in class org.jcommando.JCommandParser

This is the primary method of the parser, and is generally invoked by the user with the command-line arguments passed into their 'main'.

printUsage() - Method in class org.jcommando.JCommandParser

Print the automatically generated usage.

S

SAXHandler - class org.jcommando.SAXHandler.

satisfied(Set) - Method in class org.jcommando.And

Returns true if the 'and' requirement is satisfied.

satisfied(Set) - Method in class org.jcommando.Grouping

Abstract method implemented by subclasses of Grouping that tests whether all the requirements of the grouping have been satisfied by the supplied options.

satisfied(Set) - Method in class org.jcommando.Not

Returns true if the 'not' requirement is satisfied.

satisfied(Set) - Method in class org.jcommando.Or

Returns true if the 'or' requirement is satisfied.

satisfied(Set) - Method in class org.jcommando.Xor

Returns true if the 'xor' requirement is satisfied.

setAllowOptionless(boolean) - Method in class org.jcommando.Command

Sets whether this command will be executed even if there are no options specified..

setClassName(String) - Method in class org.jcommando.GeneratedParser

Called by parser to set the 'className' property.

setClassName(String) - Method in class org.jcommando.JCommandoGen

Set the classname.

setClassname(String) - Method in class org.jcommando.ant.JCommando

Set the name of the generated class.

setDescription(String) - Method in class org.jcommando.Command

setDescription(String) - Method in class org.jcommando.Option

Set the textual description of this option.

setDestDir(String) - Method in class org.jcommando.GeneratedParser

Called by parser to set the 'destDir' property.

setDestDir(String) - Method in class org.jcommando.JCommandoGen

Set the destination directory.

setDestdir(String) - Method in class org.jcommando.ant.JCommando

Set the destination directory.

setGrouping(Grouping) - Method in class org.jcommando.Command

Set the grouping object for this command.

setHelp() - Method in class org.jcommando.GeneratedParser

Called by parser to set the 'help' property.

setHelp() - Method in class org.jcommando.JCommandoGen

Call the super-class.

setId(String) - Method in class org.jcommando.Command

setId(String) - Method in class org.jcommando.Option

Set the unique identifier for this option.

setInputFile(String) - Method in class org.jcommando.GeneratedParser

Called by parser to set the 'inputFile' property.

setInputFile(String) - Method in class org.jcommando.JCommandoGen

Set the source command file.

setInputFile(String) - Method in class org.jcommando.ant.JCommando

Set the source command file.

setLongMnemonic(String) - Method in class org.jcommando.Option

Set the long form of this option.

setMax(double) - Method in class org.jcommando.Option

Set the maximum valid value of this option.

setMin(double) - Method in class org.jcommando.Option

Set the minumum valid value of this option.

setName(String) - Method in class org.jcommando.Command

setOptionType(String) - Method in class org.jcommando.Option

Set the Java type of this option.

setPackageName(String) - Method in class org.jcommando.GeneratedParser

Called by parser to set the 'packageName' property.

setPackageName(String) - Method in class org.jcommando.JCommandoGen

Set the package name.

setPackageName(String) - Method in class org.jcommando.ant.JCommando

Set the package name.

setShortMnemonic(String) - Method in class org.jcommando.Option

Set the short form of this option.

startDocument() - Method in class org.jcommando.SAXHandler

Overloaded method.

startElement(String, String, String, Attributes) - Method in class org.jcommando.SAXHandler

Overloaded method.

X

Xor - class org.jcommando.Xor.

Xor() - Constructor for class org.jcommando.Xor

A C D E F G I J M N O P S X