A C D G I O P T

A

AbstractParserControl - Class in org.apache.commons.cli.avalon

Class to inherit from so when in future when new controls are added clients will not have to implement them.

AbstractParserControl() - Constructor for class org.apache.commons.cli.avalon.AbstractParserControl

addArgument(String) - Method in class org.apache.commons.cli.avalon.CLOption

Mutator of Argument property.

ARGUMENT_DISALLOWED - Static variable in class org.apache.commons.cli.avalon.CLOptionDescriptor

Flag to say this option does not take arguments

ARGUMENT_OPTIONAL - Static variable in class org.apache.commons.cli.avalon.CLOptionDescriptor

Flag to say that the argument is optional

ARGUMENT_REQUIRED - Static variable in class org.apache.commons.cli.avalon.CLOptionDescriptor

Flag to say that one argument is required

ARGUMENTS_REQUIRED_2 - Static variable in class org.apache.commons.cli.avalon.CLOptionDescriptor

Flag to say this option requires 2 arguments

C

CLArgsParser - Class in org.apache.commons.cli.avalon

Parser for command line arguments.

CLArgsParser(String[], CLOptionDescriptor[], ParserControl) - Constructor for class org.apache.commons.cli.avalon.CLArgsParser

Create a parser that can deal with options and parses certain args.

CLArgsParser(String[], CLOptionDescriptor[]) - Constructor for class org.apache.commons.cli.avalon.CLArgsParser

Create a parser that deals with options and parses certain args.

CLOption - Class in org.apache.commons.cli.avalon

Basic class describing an instance of option.

CLOption(CLOptionDescriptor) - Constructor for class org.apache.commons.cli.avalon.CLOption

Constructor taking an descriptor

CLOption(String) - Constructor for class org.apache.commons.cli.avalon.CLOption

Constructor taking argument for option.

CLOptionDescriptor - Class in org.apache.commons.cli.avalon

Basic class describing an type of option.

CLOptionDescriptor(String, int, int, String) - Constructor for class org.apache.commons.cli.avalon.CLOptionDescriptor

Constructor.

CLOptionDescriptor(String, int, int, String, CLOptionDescriptor[]) - Constructor for class org.apache.commons.cli.avalon.CLOptionDescriptor

Constructor.

CLUtil - Class in org.apache.commons.cli.avalon

CLUtil offers basic utility operations for use both internal and external to package.

D

describeOptions(CLOptionDescriptor[]) - Static method in class org.apache.commons.cli.avalon.CLUtil

Format options into StringBuffer and return.

DUPLICATES_ALLOWED - Static variable in class org.apache.commons.cli.avalon.CLOptionDescriptor

Flag to say this option may be repeated on the command line

G

getArgument() - Method in class org.apache.commons.cli.avalon.CLOption

Retrieve argument to option if it takes arguments.

getArgument(int) - Method in class org.apache.commons.cli.avalon.CLOption

Retrieve indexed argument to option if it takes arguments.

getArgumentById(int) - Method in class org.apache.commons.cli.avalon.CLArgsParser

Retrieve the CLOption with specified id, or null if no command line option is found.

getArgumentByName(String) - Method in class org.apache.commons.cli.avalon.CLArgsParser

Retrieve the CLOption with specified name, or null if no command line option is found.

getArgumentCount() - Method in class org.apache.commons.cli.avalon.CLOption

Get number of arguments.

getArguments() - Method in class org.apache.commons.cli.avalon.CLArgsParser

Retrieve a list of options that were parsed from command list.

getDescription() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Retrieve textual description.

getDescriptor() - Method in class org.apache.commons.cli.avalon.CLOption

getErrorString() - Method in class org.apache.commons.cli.avalon.CLArgsParser

Retrieve an error message that occured during parsing if one existed.

getFlags() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Retrieve flags about option.

getId() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Retrieve the id for option.

getIncompatible() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Get the array of incompatible option ids.

getName() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Retrieve name of option which is also text for long option.

getUnparsedArgs() - Method in class org.apache.commons.cli.avalon.CLArgsParser

Retrieve an array of arguments that have not been parsed due to the parser halting.

I

isFinished(int) - Method in class org.apache.commons.cli.avalon.AbstractParserControl

By default always continue parsing by returning false.

isFinished(int) - Method in interface org.apache.commons.cli.avalon.ParserControl

Called by the parser to determine whether it should stop after last option parsed.

O

org.apache.commons.cli.avalon - package org.apache.commons.cli.avalon

Utility code for parsing command-line options.

P

ParserControl - Interface in org.apache.commons.cli.avalon

ParserControl is used to control particular behaviour of the parser.

T

TEXT_ARGUMENT - Static variable in class org.apache.commons.cli.avalon.CLOption

Value of #getId when the option is a text argument.

toString() - Method in class org.apache.commons.cli.avalon.CLOption

Convert to String.

toString() - Method in class org.apache.commons.cli.avalon.CLOptionDescriptor

Convert to String.

A C D G I O P T