org.apache.oodt.cas.cli.printer

Interface CmdLinePrinter

All Known Implementing Classes:

StdCmdLinePrinter

public interface CmdLinePrinter

Printer which is responsible for generating a String representation of help, validation errors, and missing required options errors.

Author:

bfoster (Brian Foster)

Method Summary

Modifier and Type	Method and Description
String	printActionHelp(CmdLineAction action, Set<CmdLineOption> options) Should generate help message for action specified by .
String	printActionMessages(List<String> messages) Generates CmdLineAction message from list of messages.
String	printActionsHelp(Set<CmdLineAction> actions) Generates help messages given CmdLineActions.
String	printOptionsHelp(Set<CmdLineOption> options) Generates help message for given CmdLineOptions.
String	printOptionValidationErrors(List<CmdLineOptionValidator.Result> results) Generate validation error message for results of failed validations.
String	printRequiredOptionsMissingError(Set<CmdLineOption> missingOptions) Generates missing required options error message from given CmdLineOptions which where required and not specified.

Method Detail

printActionHelp

String printActionHelp(CmdLineAction action,
                       Set<CmdLineOption> options)

Should generate help message for action specified by .

Parameters:

action - CmdLineAction for which help will be generate

options - Supported CmdLineOptions

Returns:

Help message for specified action

printActionsHelp

String printActionsHelp(Set<CmdLineAction> actions)

Generates help messages given CmdLineActions.

Parameters:

actions - CmdLineActions to print help for

Returns:

Help message for given CmdLineActions

printOptionsHelp

String printOptionsHelp(Set<CmdLineOption> options)

Generates help message for given CmdLineOptions.

Parameters:

options - CmdLineOptions for which help message will be generated

Returns:

Help message for given CmdLineOptions

printOptionValidationErrors

String printOptionValidationErrors(List<CmdLineOptionValidator.Result> results)

Generate validation error message for results of failed validations.

Parameters:

results - List of FAILed validations

Returns:

Generated validation error message

printRequiredOptionsMissingError

String printRequiredOptionsMissingError(Set<CmdLineOption> missingOptions)

Generates missing required options error message from given CmdLineOptions which where required and not specified.

Parameters:

missingOptions - Set of CmdLineOptions which where required and not set.

Returns:

Generated missing required options error message.

printActionMessages

String printActionMessages(List<String> messages)

Generates CmdLineAction message from list of messages.

Parameters:

messages - The messages from a CmdLineAction

Returns:

printed message from list of messages.