Uses of Interface
org.apache.oodt.cas.cli.option.CmdLineOption

Packages that use CmdLineOption

Package	Description
org.apache.oodt.cas.cli
org.apache.oodt.cas.cli.construct
org.apache.oodt.cas.cli.option
org.apache.oodt.cas.cli.option.handler
org.apache.oodt.cas.cli.option.store
org.apache.oodt.cas.cli.option.store.spring
org.apache.oodt.cas.cli.printer
org.apache.oodt.cas.cli.util
org.apache.oodt.cas.crawl.cli.option.handler

Uses of CmdLineOption in org.apache.oodt.cas.cli

Methods in org.apache.oodt.cas.cli that return types with arguments of type CmdLineOption

Modifier and Type	Method and Description
static Set<CmdLineOption>	CmdLineUtility.check(CmdLineArgs cmdLineArgs) Checks for required options which are not set and returns the ones it finds.
Set<CmdLineOption>	CmdLineArgs.getSupportedOptions()

Method parameters in org.apache.oodt.cas.cli with type arguments of type CmdLineOption

Modifier and Type	Method and Description
void	CmdLineUtility.initializeHandlers(Set<CmdLineOption> options) Initializes each CmdLineOptionHandler with their assigned CmdLineOption.
void	CmdLineUtility.printMissingRequiredOptionsError(Set<CmdLineOption> missingOptions)

Uses of CmdLineOption in org.apache.oodt.cas.cli.construct

Method parameters in org.apache.oodt.cas.cli.construct with type arguments of type CmdLineOption

Modifier and Type	Method and Description
Set<CmdLineOptionInstance>	StdCmdLineConstructor.construct(CmdLineIterable<ParsedArg> parsedArgs, Set<CmdLineOption> validOptions)
Set<CmdLineOptionInstance>	CmdLineConstructor.construct(CmdLineIterable<ParsedArg> parsedArgs, Set<CmdLineOption> validOptions)

Uses of CmdLineOption in org.apache.oodt.cas.cli.option

Classes in org.apache.oodt.cas.cli.option that implement CmdLineOption

Modifier and Type	Class and Description
class	ActionCmdLineOption CmdLineOption for specifying CmdLineAction.
class	AdvancedCmdLineOption Advanced version of a CmdLineOption which supports validation and option handling.
class	GroupCmdLineOption CmdLineOption which is a group option (i.e.
class	HelpCmdLineOption The Help CmdLineOption.
class	PrintSupportedActionsCmdLineOption The Print Supported Actions CmdLineOption.
class	SimpleCmdLineOption CmdLineOption which implements the basic methods for any CmdLineOption.

Methods in org.apache.oodt.cas.cli.option that return CmdLineOption

Modifier and Type	Method and Description
CmdLineOption	GroupSubOption.getOption()
CmdLineOption	CmdLineOptionInstance.getOption()

Methods in org.apache.oodt.cas.cli.option with parameters of type CmdLineOption

Modifier and Type	Method and Description
void	GroupSubOption.setOption(CmdLineOption option)
void	CmdLineOptionInstance.setOption(CmdLineOption option)

Constructors in org.apache.oodt.cas.cli.option with parameters of type CmdLineOption

Constructor and Description
CmdLineOptionInstance(CmdLineOption option, List<String> values)
GroupSubOption(CmdLineOption option, boolean required)

Uses of CmdLineOption in org.apache.oodt.cas.cli.option.handler

Methods in org.apache.oodt.cas.cli.option.handler with parameters of type CmdLineOption

Modifier and Type	Method and Description
String	SetJavaPropertiesHandler.getArgDescription(CmdLineAction action, CmdLineOption option)
String	CmdLineOptionHandler.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	ApplyToActionHandler.getArgDescription(CmdLineAction action, CmdLineOption option)
String	ApplyToActionHandler.getDescription(CmdLineAction action, CmdLineOption option)
String	SetJavaPropertiesHandler.getHelp(CmdLineOption option)
String	CmdLineOptionHandler.getHelp(CmdLineOption option) Gets the CmdLineOptionHandlers help message when associated with given CmdLineOption.
String	ApplyToActionHandler.getHelp(CmdLineOption option)
void	SetJavaPropertiesHandler.initialize(CmdLineOption option)
void	CmdLineOptionHandler.initialize(CmdLineOption option) Called after handler construction to allow handler to setup state before it is required to handle the option later.
void	ApplyToActionHandler.initialize(CmdLineOption option)

Uses of CmdLineOption in org.apache.oodt.cas.cli.option.store

Methods in org.apache.oodt.cas.cli.option.store that return types with arguments of type CmdLineOption

Modifier and Type	Method and Description
Set<CmdLineOption>	CmdLineOptionStore.loadSupportedOptions()

Uses of CmdLineOption in org.apache.oodt.cas.cli.option.store.spring

Methods in org.apache.oodt.cas.cli.option.store.spring that return types with arguments of type CmdLineOption

Modifier and Type	Method and Description
Set<CmdLineOption>	SpringCmdLineOptionStore.loadSupportedOptions()

Uses of CmdLineOption in org.apache.oodt.cas.cli.printer

Methods in org.apache.oodt.cas.cli.printer with parameters of type CmdLineOption

Modifier and Type	Method and Description
protected String	StdCmdLinePrinter.getOptionalOptionHelp(CmdLineAction action, CmdLineOption option)
protected String	StdCmdLinePrinter.getOptionHelp(CmdLineAction action, CmdLineOption option, String indent)
protected String	StdCmdLinePrinter.getOptionHelp(CmdLineOption option, String indent)
protected String	StdCmdLinePrinter.getRequiredOptionHelp(CmdLineAction action, CmdLineOption option)

Method parameters in org.apache.oodt.cas.cli.printer with type arguments of type CmdLineOption

Modifier and Type	Method and Description
protected String	StdCmdLinePrinter.getUsage(CmdLineAction action, Set<CmdLineOption> options)
String	StdCmdLinePrinter.printActionHelp(CmdLineAction action, Set<CmdLineOption> options)
String	CmdLinePrinter.printActionHelp(CmdLineAction action, Set<CmdLineOption> options) Should generate help message for action specified by .
String	StdCmdLinePrinter.printOptionsHelp(Set<CmdLineOption> options)
String	CmdLinePrinter.printOptionsHelp(Set<CmdLineOption> options) Generates help message for given CmdLineOptions.
String	StdCmdLinePrinter.printRequiredOptionsMissingError(Set<CmdLineOption> missingOptions)
String	CmdLinePrinter.printRequiredOptionsMissingError(Set<CmdLineOption> missingOptions) Generates missing required options error message from given CmdLineOptions which where required and not specified.

Uses of CmdLineOption in org.apache.oodt.cas.cli.util

Methods in org.apache.oodt.cas.cli.util that return CmdLineOption

Modifier and Type	Method and Description
static CmdLineOption	CmdLineUtils.getOptionByName(String optionName, Set<CmdLineOption> options) Finds CmdLineOption whose short name or long name equals given option name.
static CmdLineOption	OptionPropertyRegister.getRegisteredOption(String property)

Methods in org.apache.oodt.cas.cli.util that return types with arguments of type CmdLineOption

Modifier and Type	Method and Description
static Set<CmdLineOption>	CmdLineUtils.determineOptional(CmdLineAction action, Set<CmdLineOption> options) Determines which of the given CmdLineOptions are optional because the given CmdLineAction was specified.
static Set<CmdLineOption>	CmdLineUtils.determineRelevantSubOptions(CmdLineAction action, GroupCmdLineOption option) Determines the given GroupCmdLineOption's sub-options which affect the given CmdLineAction.
static Set<CmdLineOption>	CmdLineUtils.determineRequired(CmdLineAction action, Set<CmdLineOption> options) Determines which of the given CmdLineOptions are either always required and are required because the given CmdLineAction was specified.
static Set<CmdLineOption>	CmdLineUtils.determineRequired(CmdLineAction action, Set<CmdLineOption> options, boolean ignoreActionOption) Same as method above but optionally allows action options to be ignored.
static Set<CmdLineOption>	CmdLineUtils.determineRequiredSubOptions(CmdLineAction action, GroupCmdLineOption option) Determines the sub-options of given GroupCmdLineOption who are either always required for become requried when given CmdLineAction is specified.
static Set<CmdLineOption>	CmdLineUtils.determineRequiredSubOptions(GroupCmdLineOption option) Determines the sub-options of given GroupCmdLineOption who are always required.
static Set<CmdLineOption>	CmdLineUtils.getRequiredOptions(Set<CmdLineOption> options) Get CmdLineOptions which are always required regardless of CmdLineAction specified.
static Set<CmdLineOption>	CmdLineUtils.getRequiredOptions(Set<CmdLineOption> options, boolean ignoreActionOption) Get CmdLineOptions which are always required regardless of CmdLineAction specified.
static List<CmdLineOption>	CmdLineUtils.sortOptions(Set<CmdLineOption> options) Sorts CmdLineOptions by there long name.
static List<CmdLineOption>	CmdLineUtils.sortOptionsByRequiredStatus(Set<CmdLineOption> options) Sorts CmdLineOptions by requirement levels.

Methods in org.apache.oodt.cas.cli.util with parameters of type CmdLineOption

Modifier and Type	Method and Description
static AdvancedCmdLineOption	CmdLineUtils.asAdvancedOption(CmdLineOption option) Casts the CmdLineOption to a AdvancedCmdLineOption.
static GroupCmdLineOption	CmdLineUtils.asGroupOption(CmdLineOption option) Cast CmdLineOption to a GroupCmdLineOption.
static HelpCmdLineOption	CmdLineUtils.asHelpOption(CmdLineOption option) Casts CmdLineOption to a HelpCmdLineOption.
static SimpleCmdLineOption	CmdLineUtils.asSimpleOption(CmdLineOption option) Casts the CmdLineOption to a SimpleCmdLineOption.
static Set<CmdLineOptionInstance>	CmdLineUtils.findAllOfSpecifiedOption(CmdLineOption option, Set<CmdLineOptionInstance> specifiedOptions) Finds the CmdLineOptionInstances whose CmdLineOption is the given CmdLineOption.
static CmdLineOptionInstance	CmdLineUtils.findSpecifiedOption(CmdLineOption option, Set<CmdLineOptionInstance> specifiedOptions) Finds the first CmdLineOptionInstance whose CmdLineOption is the given CmdLineOption.
static Set<String>	OptionPropertyRegister.getProperties(CmdLineOption specifiedOption)
static boolean	CmdLineUtils.isActionOption(CmdLineOption option) Checks if CmdLineOption is a ActionCmdLineOption.
static boolean	CmdLineUtils.isAdvancedOption(CmdLineOption option) Checks if CmdLineOption is a AdvancedCmdLineOption.
static boolean	CmdLineUtils.isGroupOption(CmdLineOption option) Checks if CmdLineOption is a GroupCmdLineOption.
static boolean	CmdLineUtils.isHelpOption(CmdLineOption option) Checks if CmdLineOption is a HelpCmdLineOption.
static boolean	CmdLineUtils.isOptional(CmdLineAction action, CmdLineOption option) Determines if the given CmdLineOption is optional either because it is always optional or because the given CmdLineAction was specified.
static boolean	CmdLineUtils.isPerformAndQuitOption(CmdLineOption option) Checks if the given CmdLineOption is a perform-and-quit type CmdLineOption.
static boolean	CmdLineUtils.isPrintSupportedActionsOption(CmdLineOption option) Checks if CmdLineOption is a PrintSupportedActionsOption.
static boolean	CmdLineUtils.isRequired(CmdLineAction action, CmdLineOption option) Determines if the given CmdLineOption is required because the given CmdLineAction was specified or because it is always required.
static boolean	CmdLineUtils.isSimpleOption(CmdLineOption option) Checks if CmdLineOption is a SimpleCmdLineOption.
static boolean	CmdLineUtils.isStrictlyOptional(CmdLineAction action, CmdLineOption option) Determines if the given CmdLineOption is optional ONLY because the given CmdLineAction was specified.
static boolean	CmdLineUtils.isSubOption(CmdLineOption option, CmdLineOption subOption) Checks if given CmdLineOption is a sub-option of other given CmdLineOption.
static void	OptionPropertyRegister.registerOption(String property, CmdLineOption option)

Method parameters in org.apache.oodt.cas.cli.util with type arguments of type CmdLineOption

Modifier and Type	Method and Description
static Set<CmdLineOption>	CmdLineUtils.determineOptional(CmdLineAction action, Set<CmdLineOption> options) Determines which of the given CmdLineOptions are optional because the given CmdLineAction was specified.
static Set<CmdLineOption>	CmdLineUtils.determineRequired(CmdLineAction action, Set<CmdLineOption> options) Determines which of the given CmdLineOptions are either always required and are required because the given CmdLineAction was specified.
static Set<CmdLineOption>	CmdLineUtils.determineRequired(CmdLineAction action, Set<CmdLineOption> options, boolean ignoreActionOption) Same as method above but optionally allows action options to be ignored.
static List<ActionCmdLineOption>	CmdLineUtils.findActionOptions(Set<CmdLineOption> options) Finds all CmdLineOptions that are ActionCmdLineOptions.
static ActionCmdLineOption	CmdLineUtils.findFirstActionOption(Set<CmdLineOption> options) Find ActionCmdLineOption in Set of CmdLineOptions.
static HelpCmdLineOption	CmdLineUtils.findHelpOption(Set<CmdLineOption> options) Finds the HelpCmdLineOption in the Set of CmdLineOptions.
static PrintSupportedActionsCmdLineOption	CmdLineUtils.findPrintSupportedActionsOption(Set<CmdLineOption> options) Finds CmdLineOption of type PrintSupportedActionsCmdLineOption.
static CmdLineOption	CmdLineUtils.getOptionByName(String optionName, Set<CmdLineOption> options) Finds CmdLineOption whose short name or long name equals given option name.
static Set<CmdLineOption>	CmdLineUtils.getRequiredOptions(Set<CmdLineOption> options) Get CmdLineOptions which are always required regardless of CmdLineAction specified.
static Set<CmdLineOption>	CmdLineUtils.getRequiredOptions(Set<CmdLineOption> options, boolean ignoreActionOption) Get CmdLineOptions which are always required regardless of CmdLineAction specified.
static List<CmdLineOption>	CmdLineUtils.sortOptions(Set<CmdLineOption> options) Sorts CmdLineOptions by there long name.
static List<CmdLineOption>	CmdLineUtils.sortOptionsByRequiredStatus(Set<CmdLineOption> options) Sorts CmdLineOptions by requirement levels.

Uses of CmdLineOption in org.apache.oodt.cas.crawl.cli.option.handler

Methods in org.apache.oodt.cas.crawl.cli.option.handler with parameters of type CmdLineOption

Modifier and Type	Method and Description
String	PreconditionInfoHandler.getArgDescription(CmdLineAction action, CmdLineOption option)
String	CrawlerBeansPropHandler.getArgDescription(CmdLineAction action, CmdLineOption option)
String	CrawlerActionInfoHandler.getArgDescription(CmdLineAction action, CmdLineOption option)
String	PreconditionInfoHandler.getHelp(CmdLineOption option)
String	CrawlerBeansPropHandler.getHelp(CmdLineOption option)
String	CrawlerActionInfoHandler.getHelp(CmdLineOption option)
void	PreconditionInfoHandler.initialize(CmdLineOption option)
void	CrawlerBeansPropHandler.initialize(CmdLineOption option)
void	CrawlerActionInfoHandler.initialize(CmdLineOption option)