Rio Project 4.2 API Documentation

org.rioproject.tools.cli
Interface OptionHandler

All Known Implementing Classes:

CLI.EasterEggHandler, CLI.EmptyHandler, CLI.HelpHandler, CLI.HttpHandler, CLI.JConsoleHandler, CLI.SettingsHandler, CLI.StatsHandler, CLI.StopHandler, DirHandler, EnlistmentHandler.EnlistHandler, EnlistmentHandler.ReleaseHandler, ListHandler, MonitorControl.DeployHandler, MonitorControl.RedeployHandler, MonitorControl.UndeployHandler

public interface OptionHandler

Define plugin interface for CLI option handlers. An OptionHandler is responsible for providing a option, or activity, that will be used through the CLI.

Author:

Dennis Reedy

Method Summary

String	getUsage() Get the usage of the command
String	process(String input, BufferedReader br, PrintStream out) Process the option.

Method Detail

process

String process(String input,
               BufferedReader br,
               PrintStream out)

Process the option.

Parameters:

input - Parameters for the option, may be null

br - An optional BufferdReader, used if the option requires input. if this is null, the option handler may create a BufferedReader to handle the input

out - The PrintStream to use if the option prints results or choices for the user. Must not be null

Returns:

The result of the action.

getUsage

String getUsage()

Get the usage of the command

Returns:

Command usage