org.jboss.forge.addon.shell.aesh

Class AbstractShellInteraction

java.lang.Object

org.jboss.forge.addon.shell.aesh.AbstractShellInteraction

All Implemented Interfaces:

Comparable<AbstractShellInteraction>

Direct Known Subclasses:

ShellSingleCommand, ShellWizard

public abstract class AbstractShellInteraction
extends Object
implements Comparable<AbstractShellInteraction>

Author:

George Gastaldi

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandLineUtil	commandLineUtil

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractShellInteraction(org.jboss.forge.addon.ui.UICommand root, ShellContext shellContext, CommandLineUtil commandLineUtil)

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,org.jboss.forge.addon.ui.input.InputComponent<?,Object>>	buildInputs(org.jboss.forge.addon.ui.UICommand command)
int	compareTo(AbstractShellInteraction o)
boolean	equals(Object o)
abstract org.jboss.forge.addon.ui.result.Result	execute()
abstract List<String>	getCompletionOptions(String typed, String line)
ShellContext	getContext()
abstract Map<String,org.jboss.forge.addon.ui.input.InputComponent<?,Object>>	getInputs()
String	getName()
org.jboss.forge.addon.ui.UICommand	getSourceCommand()
int	hashCode()
abstract org.jboss.aesh.cl.parser.ParsedCompleteObject	parseCompleteObject(String line)
abstract void	populateInputs(String line, boolean lenient)
protected void	removeExistingOptions(String commandLine, Iterable<String> availableOptions)
String	toString()
abstract List<String>	validate() Returns the error messages

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

commandLineUtil

protected final CommandLineUtil commandLineUtil

Constructor Detail

AbstractShellInteraction

protected AbstractShellInteraction(org.jboss.forge.addon.ui.UICommand root,
                        ShellContext shellContext,
                        CommandLineUtil commandLineUtil)

Method Detail

getInputs

public abstract Map<String,org.jboss.forge.addon.ui.input.InputComponent<?,Object>> getInputs()

getCompletionOptions

public abstract List<String> getCompletionOptions(String typed,
                                String line)

parseCompleteObject

public abstract org.jboss.aesh.cl.parser.ParsedCompleteObject parseCompleteObject(String line)
                                                                           throws org.jboss.aesh.cl.exception.CommandLineParserException

Throws:

org.jboss.aesh.cl.exception.CommandLineParserException

populateInputs

public abstract void populateInputs(String line,
                  boolean lenient)
                             throws org.jboss.aesh.cl.exception.CommandLineParserException

Throws:

org.jboss.aesh.cl.exception.CommandLineParserException

validate

public abstract List<String> validate()

Returns the error messages

Returns:

execute

public abstract org.jboss.forge.addon.ui.result.Result execute()
                                                        throws Exception

Throws:

Exception

buildInputs

protected Map<String,org.jboss.forge.addon.ui.input.InputComponent<?,Object>> buildInputs(org.jboss.forge.addon.ui.UICommand command)

getSourceCommand

public org.jboss.forge.addon.ui.UICommand getSourceCommand()

getName

public final String getName()

getContext

public final ShellContext getContext()

compareTo

public int compareTo(AbstractShellInteraction o)

Specified by:

compareTo in interface Comparable<AbstractShellInteraction>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

removeExistingOptions

protected void removeExistingOptions(String commandLine,
                         Iterable<String> availableOptions)