Package 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, AbstractProvisionWithPlugins, StateAddFeatureCommand

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

Dynamic command support.

Author:

jdenise@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDynamicCommand.DynamicOption

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_NAME
protected PmSession	pmSession

Constructor Summary

Constructors

Constructor	Description
AbstractDynamicCommand(PmSession pmSession, boolean optimizeRetrieval)

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	canComplete(PmSession pmSession)
boolean	checkForRequiredOptions(org.aesh.parser.ParsedLine pl)
org.aesh.command.container.CommandContainer	createCommand()
protected abstract void	doValidateOptions(PmCommandInvocation invoc)
org.aesh.command.CommandResult	execute(PmCommandInvocation session)
protected abstract PmCommandActivator	getActivator()
protected java.util.List<java.lang.String>	getArgumentsValues()
protected java.lang.String	getArgumentValue()
protected abstract java.lang.String	getDescription()
abstract CommandDomain	getDomain()
protected abstract java.util.List<AbstractDynamicCommand.DynamicOption>	getDynamicOptions(State state)
protected abstract java.lang.String	getName()
protected java.lang.String	getOptionValue(java.lang.String name)
protected abstract java.util.List<org.aesh.command.impl.internal.ProcessedOption>	getStaticOptions()
protected abstract void	runCommand(PmCommandInvocation session, java.util.Map<java.lang.String,java.lang.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 java.lang.String ARGUMENT_NAME

See Also:

Constant Field Values

pmSession

protected final PmSession pmSession

Constructor Detail

AbstractDynamicCommand

public AbstractDynamicCommand(PmSession pmSession,
                              boolean optimizeRetrieval)

Parameters:

pmSession - The session

optimizeRetrieval - True, optimize retrieval.

Method Detail

getName

protected abstract java.lang.String getName()

getDescription

protected abstract java.lang.String getDescription()

getDynamicOptions

protected abstract java.util.List<AbstractDynamicCommand.DynamicOption> getDynamicOptions(State state)
                                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

runCommand

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

Throws:

CommandExecutionException

getStaticOptions

protected abstract java.util.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()

getDomain

public abstract CommandDomain getDomain()

createCommand

public org.aesh.command.container.CommandContainer 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 java.lang.String getArgumentValue()

getOptionValue

protected java.lang.String getOptionValue(java.lang.String name)

getArgumentsValues

protected java.util.List<java.lang.String> getArgumentsValues()

doValidateOptions

protected abstract void doValidateOptions(PmCommandInvocation invoc)
                                   throws CommandExecutionException

Throws:

CommandExecutionException

canComplete

protected abstract boolean canComplete(PmSession pmSession)