A C D G I O P T

A

AbstractParserControl - class org.apache.avalon.excalibur.cli.AbstractParserControl.
Class to inherit from so when in future when new controls are added clients will no have to implement them.
AbstractParserControl() - Constructor for class org.apache.avalon.excalibur.cli.AbstractParserControl
 
addArgument(String) - Method in class org.apache.avalon.excalibur.cli.CLOption
Mutator of Argument property.
ARGUMENT_DISALLOWED - Static variable in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Flag to say this option does not take arguments
ARGUMENT_OPTIONAL - Static variable in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Flag to say that the argument is optional
ARGUMENT_REQUIRED - Static variable in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Flag to say that one argument is required
ARGUMENTS_REQUIRED_2 - Static variable in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Flag to say this option requires 2 arguments

C

CLArgsParser - class org.apache.avalon.excalibur.cli.CLArgsParser.
Parser for command line arguments.
CLArgsParser(String[], CLOptionDescriptor[]) - Constructor for class org.apache.avalon.excalibur.cli.CLArgsParser
Create a parser that deals with options and parses certain args.
CLArgsParser(String[], CLOptionDescriptor[], ParserControl) - Constructor for class org.apache.avalon.excalibur.cli.CLArgsParser
Create a parser that can deal with options and parses certain args.
CLOption - class org.apache.avalon.excalibur.cli.CLOption.
Basic class describing an instance of option.
CLOption(int) - Constructor for class org.apache.avalon.excalibur.cli.CLOption
Constructor taking an id (that must be a proper character code)
CLOption(String) - Constructor for class org.apache.avalon.excalibur.cli.CLOption
Constructor taking argument for option.
CLOptionDescriptor - class org.apache.avalon.excalibur.cli.CLOptionDescriptor.
Basic class describing an type of option.
CLOptionDescriptor(String, int, int, String) - Constructor for class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Constructor.
CLOptionDescriptor(String, int, int, String, int[]) - Constructor for class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Constructor.
CLUtil - class org.apache.avalon.excalibur.cli.CLUtil.
CLUtil offers basic utility operations for use both internal and external to package.

D

describeOptions(CLOptionDescriptor[]) - Static method in class org.apache.avalon.excalibur.cli.CLUtil
Format options into StringBuffer and return.
DUPLICATES_ALLOWED - Static variable in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Flag to say this option may be repeated on the command line

G

getArgument() - Method in class org.apache.avalon.excalibur.cli.CLOption
Retrieve argument to option if it takes arguments.
getArgument(int) - Method in class org.apache.avalon.excalibur.cli.CLOption
Retrieve indexed argument to option if it takes arguments.
getArgumentById(int) - Method in class org.apache.avalon.excalibur.cli.CLArgsParser
Retrieve the CLOption with specified id, or null if no command line option is found.
getArgumentByName(String) - Method in class org.apache.avalon.excalibur.cli.CLArgsParser
Retrieve the CLOption with specified name, or null if no command line option is found.
getArgumentCount() - Method in class org.apache.avalon.excalibur.cli.CLOption
Get number of arguments.
getArguments() - Method in class org.apache.avalon.excalibur.cli.CLArgsParser
Retrieve a list of options that were parsed from command list.
getDescription() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Retrieve textual description.
getErrorString() - Method in class org.apache.avalon.excalibur.cli.CLArgsParser
Retrieve an error message that occured during parsing if one existed.
getFlags() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Retrieve flags about option.
getId() - Method in class org.apache.avalon.excalibur.cli.CLOption
Retrieve id of option.
getId() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Retrieve the id for option.
getIncompatble() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Deprecated. Use the correctly spelled CLOptionDescriptor.getIncompatible() instead.
getIncompatible() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Get the array of incompatible option ids.
getName() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Retrieve name of option which is also text for long option.
getUnparsedArgs() - Method in class org.apache.avalon.excalibur.cli.CLArgsParser
Retrieve an array of arguments that have not been parsed due to the parser halting.

I

isFinished(int) - Method in class org.apache.avalon.excalibur.cli.AbstractParserControl
By default always continue parsing by returning false.
isFinished(int) - Method in interface org.apache.avalon.excalibur.cli.ParserControl
Called by the parser to determine whether it should stop after last option parsed.

O

org.apache.avalon.excalibur.cli - package org.apache.avalon.excalibur.cli
Utility code for parsing command-line options.

P

ParserControl - interface org.apache.avalon.excalibur.cli.ParserControl.
ParserControl is used to control particular behaviour of the parser.

T

TEXT_ARGUMENT - Static variable in class org.apache.avalon.excalibur.cli.CLOption
Value of CLOption.getId() when the option is a text argument.
toString() - Method in class org.apache.avalon.excalibur.cli.CLOption
Convert to String.
toString() - Method in class org.apache.avalon.excalibur.cli.CLOptionDescriptor
Convert to String.

A C D G I O P T

"Copyright © 2000-2002 Apache Jakarta Project. All Rights Reserved."