@PublicAPI(stability=PRIVATE)

Package org.opends.server.util.args

Provides an implementation of a utility that can manage the processing of command-line arguments for an application.

See:
          Description

Class Summary
Argument This class defines a generic argument that may be used in the argument list for an application.
ArgumentGroup Class for organizing options into logical groups when arguement usage is printed.
ArgumentParser This class defines a utility that can be used to deal with command-line arguments for applications in a CLIP-compliant manner using either short one-character or longer word-based arguments.
BooleanArgument This class defines an argument type that will be used to represent Boolean values.
FileBasedArgument This class defines an argument whose value will be read from a file rather than actually specified on the command-line.
IntegerArgument This class defines an argument type that will only accept integer values, and potentially only those in a given range.
LDAPConnectionArgumentParser Creates an argument parser pre-populated with arguments for specifying information for openning and LDAPConnection an LDAP connection.
MultiChoiceArgument This class defines an argument type that will only accept one or more of a specific set of string values.
StringArgument This class defines an argument type that will accept any string value.
SubCommand This class defines a data structure for holding information about a subcommand that may be used with the subcommand argument parser.
SubCommandArgumentParser This class defines a variant of the argument parser that can be used with applications that use subcommands to customize their behavior and that have a different set of options per subcommand (e.g, "cvs checkout" takes different options than "cvs commit").
 

Exception Summary
ArgumentException This class defines an exception that may be thrown if there is a problem with an argument definition.
 

Package org.opends.server.util.args Description

Provides an implementation of a utility that can manage the processing of command-line arguments for an application. This class centralizes a significant amount of processing so that it does not need to be repeated in all tools requiring this kind of functionality, as well as helping to ensure that the interaction with program arguments is in compliance with Sun's CLIP specification.

Features offered by this argument parsing implementation include:


A second version of the argument parser is also available which does not include support for trailing arguments but does include support for the use of subcommands. In this case, you can define a number of subcommands each with their own set of arguments. This can be used for cases in which one umbrella utility has a number of different capabilities (e.g., the "cvs" command has a number of sub-commands like "checkout" and "commit" and "diff", each of which has its own set of options).