Uses of Interface
net.sf.mmm.util.cli.api.CliModeObject

Packages that use CliModeObject

Package	Description
net.sf.mmm.util.cli.api	Provides the API for utilities that help to build command-line-interfaces (CLI).
net.sf.mmm.util.cli.base	Contains the base-implementation of utilities that help to build command-line-interfaces (CLI).

Uses of CliModeObject in net.sf.mmm.util.cli.api

Methods in net.sf.mmm.util.cli.api that return CliModeObject

Modifier and Type	Method and Description
CliModeObject	CliParser.parseParameters(String... parameters) This method parses the given command-line parameters and applies the parsed options and arguments to the Pojo that was supplied when building this parser.

Methods in net.sf.mmm.util.cli.api with parameters of type CliModeObject

Modifier and Type	Method and Description
boolean	CliModeObject.isAncestorOf(CliModeObject childMode) Determines if this CliModeObject is an ancestor of the given childMode.
boolean	CliModeObject.isDescendantOf(CliModeObject parentMode) Determines if this CliModeObject is a descendant of the given parentMode.
protected int	AbstractVersionedMain.run(CliModeObject mode)
protected abstract int	AbstractMain.run(CliModeObject mode) This method is called after the options are parsed and injected.
protected void	AbstractMain.validate(CliModeObject mode) This method is called after the command-line arguments are checked for syntactically correctness and applied to this class in order to perform complex validations.

Uses of CliModeObject in net.sf.mmm.util.cli.base

Classes in net.sf.mmm.util.cli.base that implement CliModeObject

Modifier and Type	Class and Description
class	CliModeContainer This is a container for a CliMode together with additional associated information.

Fields in net.sf.mmm.util.cli.base declared as CliModeObject

Modifier and Type	Field and Description
private CliModeObject	AbstractCliParser.CliParserState.currentMode

Methods in net.sf.mmm.util.cli.base that return CliModeObject

Modifier and Type	Method and Description
CliModeObject	AbstractCliParser.CliParserState.getCurrentMode() This method gets the current mode that was detected so far.
CliModeObject	CliClassContainer.getMode(String id) This method gets the mode associated with the given ID.
CliModeObject	AbstractCliParser.parseParameters(String... parameters)
protected CliModeObject	AbstractCliParser.CliParserState.requireCurrentMode(CliState cliState) Like AbstractCliParser.CliParserState.getCurrentMode() but initializes to default if null.
protected CliModeObject	CliState.requireMode(String id, Object annotationContainer) This method is like CliClassContainer.getMode(String) but also handles the case that a CliMode may be undefined.

Methods in net.sf.mmm.util.cli.base with parameters of type CliModeObject

Modifier and Type	Method and Description
List<CliArgumentContainer>	CliState.getArguments(CliModeObject mode) This method gets the List of CLI-arguments for the given mode.
Collection<CliOptionContainer>	CliState.getOptions(CliModeObject mode) This method gets the options for the given mode.
boolean	CliModeContainer.isAncestorOf(CliModeObject childMode)
boolean	CliModeContainer.isDescendantOf(CliModeObject parentMode)
void	AbstractCliParser.CliParserState.setCurrentMode(String option, CliModeObject mode) This method sets current mode and mode-option.