org.apache.oodt.cas.cli.option.handler

Interface CmdLineOptionHandler

All Known Implementing Classes:

ApplyToActionHandler, BeanInfoHandler, CrawlerActionInfoHandler, CrawlerBeansPropHandler, PreconditionInfoHandler, SetJavaPropertiesHandler

public interface CmdLineOptionHandler

Handles a CmdLineOption's values in relation to given CmdLineActions.

Author:

bfoster (Brian Foster)

Method Summary

Modifier and Type	Method and Description
String	getArgDescription(CmdLineAction action, CmdLineOption option) If this handler causes the argument descriptor to be different for certain CmdLineActions, then should return the arg description here.
String	getHelp(CmdLineOption option) Gets the CmdLineOptionHandlers help message when associated with given CmdLineOption.
void	handleOption(CmdLineAction selectedAction, CmdLineOptionInstance optionInstance)
void	initialize(CmdLineOption option) Called after handler construction to allow handler to setup state before it is required to handle the option later.

Method Detail

initialize

void initialize(CmdLineOption option)

Called after handler construction to allow handler to setup state before it is required to handle the option later. This is also called when help is run so allows registration to take place if necessary for help analysis.

handleOption

void handleOption(CmdLineAction selectedAction,
                  CmdLineOptionInstance optionInstance)

getHelp

String getHelp(CmdLineOption option)

Gets the CmdLineOptionHandlers help message when associated with given CmdLineOption.

Parameters:

option - The CmdLineOption to which this CmdLineOptionHandler was associated with

Returns:

The help message for this CmdLineOptionHandler

getArgDescription

String getArgDescription(CmdLineAction action,
                         CmdLineOption option)

If this handler causes the argument descriptor to be different for certain CmdLineActions, then should return the arg description here.