org.apache.oodt.cas.cli.printer

Class StdCmdLinePrinter

java.lang.Object

org.apache.oodt.cas.cli.printer.StdCmdLinePrinter

All Implemented Interfaces:

CmdLinePrinter

public class StdCmdLinePrinter
extends Object
implements CmdLinePrinter

Standard CmdLinePrinter.

Author:

bfoster (Brian Foster)

Constructor Summary

Constructors

Constructor and Description
StdCmdLinePrinter()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getDescription(CmdLineAction action)
protected String	getExamples(CmdLineAction action)
protected String	getFooter()
protected String	getFooter(CmdLineAction action)
protected String	getGroupHelp(CmdLineAction action, GroupCmdLineOption option, String indent)
protected String	getHeader()
protected String	getHeader(CmdLineAction action)
protected String	getOptionalOptionHelp(CmdLineAction action, CmdLineOption option)
protected String	getOptionalSubHeader()
protected String	getOptionHelp(CmdLineAction action, CmdLineOption option, String indent)
protected String	getOptionHelp(CmdLineOption option, String indent)
protected String	getRequiredOptionHelp(CmdLineAction action, CmdLineOption option)
protected String	getRequiredSubHeader()
protected String	getUsage(CmdLineAction action, Set<CmdLineOption> options)
String	printActionHelp(CmdLineAction action, Set<CmdLineOption> options) Should generate help message for action specified by #CmdLineArgs.getSpecifiedAction().
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StdCmdLinePrinter

public StdCmdLinePrinter()

Method Detail

printActionHelp

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

Description copied from interface: CmdLinePrinter

Should generate help message for action specified by #CmdLineArgs.getSpecifiedAction().

Specified by:

printActionHelp in interface CmdLinePrinter

Parameters:

action - CmdLineAction for which help will be generate

options - Supported CmdLineOptions

Returns:

Help message for specified action

getHeader

protected String getHeader(CmdLineAction action)

getDescription

protected String getDescription(CmdLineAction action)

getUsage

protected String getUsage(CmdLineAction action,
              Set<CmdLineOption> options)

getRequiredSubHeader

protected String getRequiredSubHeader()

getRequiredOptionHelp

protected String getRequiredOptionHelp(CmdLineAction action,
                           CmdLineOption option)

getOptionalSubHeader

protected String getOptionalSubHeader()

getOptionalOptionHelp

protected String getOptionalOptionHelp(CmdLineAction action,
                           CmdLineOption option)

getExamples

protected String getExamples(CmdLineAction action)

getFooter

protected String getFooter(CmdLineAction action)

getOptionHelp

protected String getOptionHelp(CmdLineAction action,
                   CmdLineOption option,
                   String indent)

getGroupHelp

protected String getGroupHelp(CmdLineAction action,
                  GroupCmdLineOption option,
                  String indent)

printActionsHelp

public String printActionsHelp(Set<CmdLineAction> actions)

Description copied from interface: CmdLinePrinter

Generates help messages given CmdLineActions.

Specified by:

printActionsHelp in interface CmdLinePrinter

Parameters:

actions - CmdLineActions to print help for

Returns:

Help message for given CmdLineActions

printOptionsHelp

public String printOptionsHelp(Set<CmdLineOption> options)

Description copied from interface: CmdLinePrinter

Generates help message for given CmdLineOptions.

Specified by:

printOptionsHelp in interface CmdLinePrinter

Parameters:

options - CmdLineOptions for which help message will be generated

Returns:

Help message for given CmdLineOptions

getHeader

protected String getHeader()

getOptionHelp

protected String getOptionHelp(CmdLineOption option,
                   String indent)

getFooter

protected String getFooter()

printOptionValidationErrors

public String printOptionValidationErrors(List<CmdLineOptionValidator.Result> results)

Description copied from interface: CmdLinePrinter

Generate validation error message for results of failed validations.

Specified by:

printOptionValidationErrors in interface CmdLinePrinter

Parameters:

results - List of FAILed validations

Returns:

Generated validation error message

printRequiredOptionsMissingError

public String printRequiredOptionsMissingError(Set<CmdLineOption> missingOptions)

Description copied from interface: CmdLinePrinter

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

Specified by:

printRequiredOptionsMissingError in interface CmdLinePrinter

Parameters:

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

Returns:

Generated missing required options error message.

printActionMessages

public String printActionMessages(List<String> messages)

Description copied from interface: CmdLinePrinter

Generates CmdLineAction message from list of messages.

Specified by:

printActionMessages in interface CmdLinePrinter

Parameters:

messages - The messages from a CmdLineAction

Returns:

printed message from list of messages.