@PublicAPI(stability=PRIVATE)

Package org.opends.server.util.cli

Provides a high-level framework for implementing command-line tools.

See:
          Description

Interface Summary
HelpCallback An interface for displaying help interactively.
Menu<T> An interactive console-based menu.
MenuCallback<T> A menu call-back which should be associated with each menu option.
ValidationCallback<T> An interface for validating user input.
 

Class Summary
CommandBuilder Class used to be able to generate the non interactive mode.
ConsoleApplication This class provides an abstract base class which can be used as the basis of a console-based application.
ErrorStreamConsoleApplication A console application decorator which redirects all output to the underlying application's error stream.
LDAPConnectionConsoleInteraction Supports interacting with a user through the command line to prompt for information necessary to create an LDAP connection.
MenuBuilder<T> An interface for incrementally building a command-line menu.
MenuResult<T> The result of running a Menu.
OutputStreamConsoleApplication A console application decorator which redirects all output to the underlying application's output stream.
 

Exception Summary
CLIException Thrown to indicate that a problem occurred when interacting with the client.
 

Package org.opends.server.util.cli Description

Provides a high-level framework for implementing command-line tools.

The ConsoleApplication interface can be used as a basis for console based applications. It includes common utility methods for interacting with the console.

The MenuBuilder and associated classes and interfaces can be used to implement text based menu driven applications.