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

Class ApplyToActionHandler

java.lang.Object

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

All Implemented Interfaces:

CmdLineOptionHandler

public class ApplyToActionHandler
extends Object
implements CmdLineOptionHandler

CmdLineOptionHandler which applies CmdLineOption values to given CmdLineAction. If CmdLineOption is a repeating option then "add" is invoked on CmdLineAction, otherwise "set

Author:

bfoster (Brian Foster)

Constructor Summary

Constructors

Constructor and Description
ApplyToActionHandler()

Method Summary

Modifier and Type	Method and Description
List<ApplyToAction>	getApplyToActions()
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.
protected String	getArgDescription(String actionName)
String	getDescription(CmdLineAction action, CmdLineOption option)
protected String	getDescription(String actionName)
String	getHelp(CmdLineOption option) Gets the CmdLineOptionHandlers help message when associated with given CmdLineOption.
protected String	getMethodName(String actionName)
void	handleOption(CmdLineAction action, 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.
void	setApplyToActions(List<ApplyToAction> applyToActions)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyToActionHandler

public ApplyToActionHandler()

Method Detail

setApplyToActions

public void setApplyToActions(List<ApplyToAction> applyToActions)

getApplyToActions

public List<ApplyToAction> getApplyToActions()

initialize

public void initialize(CmdLineOption option)

Description copied from interface: CmdLineOptionHandler

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.

Specified by:

initialize in interface CmdLineOptionHandler

handleOption

public void handleOption(CmdLineAction action,
                         CmdLineOptionInstance optionInstance)

Specified by:

handleOption in interface CmdLineOptionHandler

getMethodName

protected String getMethodName(String actionName)

getDescription

protected String getDescription(String actionName)

getArgDescription

protected String getArgDescription(String actionName)

getHelp

public String getHelp(CmdLineOption option)

Description copied from interface: CmdLineOptionHandler

Gets the CmdLineOptionHandlers help message when associated with given CmdLineOption.

Specified by:

getHelp in interface CmdLineOptionHandler

Parameters:

option - The CmdLineOption to which this CmdLineOptionHandler was associated with

Returns:

The help message for this CmdLineOptionHandler

getDescription

public String getDescription(CmdLineAction action,
                             CmdLineOption option)

getArgDescription

public String getArgDescription(CmdLineAction action,
                                CmdLineOption option)

Description copied from interface: CmdLineOptionHandler

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

Specified by:

getArgDescription in interface CmdLineOptionHandler