org.jboss.galleon.cli.cmd

Class AbstractDynamicCommand

java.lang.Object

org.aesh.command.map.MapCommand<PmCommandInvocation>

org.jboss.galleon.cli.cmd.AbstractDynamicCommand

All Implemented Interfaces:

org.aesh.command.Command<PmCommandInvocation>

Direct Known Subclasses:

AbstractPluginsCommand, StateAddFeatureCommand, StateProvisionCommand

public abstract class AbstractDynamicCommand
extends org.aesh.command.map.MapCommand<PmCommandInvocation>

Dynamic command that retrieves options based on the argument value.

Author:

jdenise@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractDynamicCommand.DynamicOption

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARGUMENT_NAME
protected PmSession	pmSession

Constructor Summary

Constructors

Constructor and Description
AbstractDynamicCommand(PmSession pmSession, boolean optimizeRetrieval, boolean requireId)

Method Summary

Modifier and Type	Method and Description
boolean	checkForRequiredOptions(org.aesh.parser.ParsedLine pl)
org.aesh.command.container.CommandContainer<org.aesh.command.Command<PmCommandInvocation>,PmCommandInvocation>	createCommand()
protected abstract void	doValidateOptions()
org.aesh.command.CommandResult	execute(PmCommandInvocation session)
protected abstract PmCommandActivator	getActivator()
protected List<String>	getArgumentsValues()
protected String	getArgumentValue()
protected abstract String	getDescription()
protected abstract List<AbstractDynamicCommand.DynamicOption>	getDynamicOptions(State state, String id)
protected abstract String	getId(PmSession session)
protected abstract String	getName()
protected String	getOptionValue(String name)
protected abstract List<org.aesh.command.impl.internal.ProcessedOption>	getStaticOptions()
protected abstract void	runCommand(PmCommandInvocation session, Map<String,String> options)

Methods inherited from class org.aesh.command.map.MapCommand

contains, getValue, getValues, resetValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_NAME

public static final String ARGUMENT_NAME

See Also:

Constant Field Values

pmSession

protected final PmSession pmSession

Constructor Detail

AbstractDynamicCommand

public AbstractDynamicCommand(PmSession pmSession,
                              boolean optimizeRetrieval,
                              boolean requireId)

Parameters:

pmSession - The session

optimizeRetrieval - True, optimize retrieval.

Method Detail

getId

protected abstract String getId(PmSession session)
                         throws CommandExecutionException

Throws:

CommandExecutionException

getName

protected abstract String getName()

getDescription

protected abstract String getDescription()

getDynamicOptions

protected abstract List<AbstractDynamicCommand.DynamicOption> getDynamicOptions(State state,
                                                                                String id)
                                                                         throws Exception

Throws:

Exception

runCommand

protected abstract void runCommand(PmCommandInvocation session,
                                   Map<String,String> options)
                            throws CommandExecutionException

Throws:

CommandExecutionException

getStaticOptions

protected abstract List<org.aesh.command.impl.internal.ProcessedOption> getStaticOptions()
                                                                                  throws org.aesh.command.parser.OptionParserException

Throws:

org.aesh.command.parser.OptionParserException

getActivator

protected abstract PmCommandActivator getActivator()

createCommand

public org.aesh.command.container.CommandContainer<org.aesh.command.Command<PmCommandInvocation>,PmCommandInvocation> createCommand()
                                                                                                                             throws org.aesh.command.parser.CommandLineParserException

Throws:

org.aesh.command.parser.CommandLineParserException

checkForRequiredOptions

public final boolean checkForRequiredOptions(org.aesh.parser.ParsedLine pl)

Overrides:

checkForRequiredOptions in class org.aesh.command.map.MapCommand<PmCommandInvocation>

execute

public org.aesh.command.CommandResult execute(PmCommandInvocation session)
                                       throws org.aesh.command.CommandException

Throws:

org.aesh.command.CommandException

getArgumentValue

protected String getArgumentValue()

getOptionValue

protected String getOptionValue(String name)

getArgumentsValues

protected List<String> getArgumentsValues()

doValidateOptions

protected abstract void doValidateOptions()
                                   throws CommandExecutionException

Throws:

CommandExecutionException