org.apache.oodt.cas.cli

Class CmdLineUtility

java.lang.Object

org.apache.oodt.cas.cli.CmdLineUtility

public class CmdLineUtility
extends Object

A highly configurable utility class which supports parsing and handling of command line arguments via its action driven design. After parsing the command line arguments it will check for required arguments not specified, validate the arguments, run the arguments handlers and then invoke the specified action. It also supports print out help messages and printing supported actions.

Author:

bfoster (Brian Foster)

Constructor Summary

Constructors

Constructor and Description
CmdLineUtility()

Method Summary

Modifier and Type	Method and Description
static Set<CmdLineOption>	check(CmdLineArgs cmdLineArgs) Checks for required options which are not set and returns the ones it finds.
void	execute(CmdLineArgs cmdLineArgs) Checks if required options are set and validation passes, then runs handlers and executes its action.
CmdLineActionStore	getActionStore()
CmdLineOptionStore	getOptionStore()
CmdLinePresenter	getPresenter()
CmdLinePrinter	getPrinter()
static void	handle(CmdLineArgs cmdLineArgs) Runs the CmdLineOptionHandlers for CmdLineArgs given.
boolean	handleHelp(CmdLineArgs cmdLineArgs) Checks if help option was specified and if so prints out help.
boolean	handlePrintSupportedActions(CmdLineArgs cmdLineArgs) Checks if print supported actions option was specified and if so prints out supported actions.
void	initializeHandlers(Set<CmdLineOption> options) Initializes each CmdLineOptionHandler with their assigned CmdLineOption.
CmdLineArgs	parse(String[] args) Parses the given command line arguments and converts it to CmdLineArgs.
void	printActionHelp(CmdLineArgs cmdLineArgs)
void	printActionMessages(List<String> messages)
void	printActionsHelp(CmdLineArgs cmdLineArgs)
void	printErrorMessage(String errorMessage)
void	printMissingRequiredOptionsError(Set<CmdLineOption> missingOptions)
void	printOptionHelp(CmdLineArgs cmdLineArgs)
void	printValidationErrors(List<CmdLineOptionValidator.Result> results)
void	run(String[] args) Parses given command line arguments, then checks for help and print supported actions options, prints them out if found, otherwise performs execution on the arguments - see execute(CmdLineArgs).
void	setActionStore(CmdLineActionStore actionStore)
void	setOptionStore(CmdLineOptionStore optionStore)
void	setPresenter(CmdLinePresenter presenter)
void	setPrinter(CmdLinePrinter printer)
static List<CmdLineOptionValidator.Result>	validate(CmdLineArgs cmdLineArgs) Runs validation on CmdLineArgs and returns the validation results.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLineUtility

public CmdLineUtility()

Method Detail

getOptionStore

public CmdLineOptionStore getOptionStore()

setOptionStore

public void setOptionStore(CmdLineOptionStore optionStore)

getActionStore

public CmdLineActionStore getActionStore()

setActionStore

public void setActionStore(CmdLineActionStore actionStore)

getPrinter

public CmdLinePrinter getPrinter()

setPrinter

public void setPrinter(CmdLinePrinter printer)

getPresenter

public CmdLinePresenter getPresenter()

setPresenter

public void setPresenter(CmdLinePresenter presenter)

printOptionHelp

public void printOptionHelp(CmdLineArgs cmdLineArgs)

printActionHelp

public void printActionHelp(CmdLineArgs cmdLineArgs)

printActionsHelp

public void printActionsHelp(CmdLineArgs cmdLineArgs)

printActionMessages

public void printActionMessages(List<String> messages)

printValidationErrors

public void printValidationErrors(List<CmdLineOptionValidator.Result> results)

printMissingRequiredOptionsError

public void printMissingRequiredOptionsError(Set<CmdLineOption> missingOptions)

printErrorMessage

public void printErrorMessage(String errorMessage)

run

public void run(String[] args)

Parses given command line arguments, then checks for help and print supported actions options, prints them out if found, otherwise performs execution on the arguments - see execute(CmdLineArgs).

Parameters:

args - The who will be parsed and executed.

parse

public CmdLineArgs parse(String[] args)
                  throws CmdLineActionStoreException,
                         CmdLineConstructionException

Parses the given command line arguments and converts it to CmdLineArgs.

Parameters:

args - The command line arguments to parse.

Returns:

The parsed command line arguments in CmdLineArgs form.

Throws:

IOException - On error parsing command line arguments.

CmdLineConstructionException - On error constructing command line arguments.

CmdLineOptionStoreException

CmdLineActionStoreException

initializeHandlers

public void initializeHandlers(Set<CmdLineOption> options)

Initializes each CmdLineOptionHandler with their assigned CmdLineOption.

Parameters:

options -

handleHelp

public boolean handleHelp(CmdLineArgs cmdLineArgs)

Checks if help option was specified and if so prints out help.

Parameters:

cmdLineArgs - The CmdLineArgs which will be checked for help option

Returns:

True if help was printed, false otherwise

handlePrintSupportedActions

public boolean handlePrintSupportedActions(CmdLineArgs cmdLineArgs)

Checks if print supported actions option was specified and if so prints out supported actions.

Parameters:

cmdLineArgs - The CmdLineArgs which will be checked for print supported action options

Returns:

True if supported actions was printed, false otherwise

execute

public void execute(CmdLineArgs cmdLineArgs)
             throws CmdLineActionExecutionException,
                    CmdLineActionException

Checks if required options are set and validation passes, then runs handlers and executes its action.

Parameters:

cmdLineArgs - The CmdLineArgs for which execution processing will be run.

Throws:

CmdLineActionExecutionException

CmdLineActionException

check

public static Set<CmdLineOption> check(CmdLineArgs cmdLineArgs)

Checks for required options which are not set and returns the ones it finds.

Parameters:

cmdLineArgs - The CmdLineArgs which will be check for required options.

Returns:

The required CmdLineOptions not specified.

validate

public static List<CmdLineOptionValidator.Result> validate(CmdLineArgs cmdLineArgs)

Runs validation on CmdLineArgs and returns the validation results.

Parameters:

cmdLineArgs - The CmdLineArgs which will be validated.

Returns:

The CmdLineOptionValidator.Results generated when running CmdLineOptionValidators.

handle

public static void handle(CmdLineArgs cmdLineArgs)

Runs the CmdLineOptionHandlers for CmdLineArgs given.

Parameters:

cmdLineArgs - The CmdLineArgs whose option handlers will be run.