org.jboss.forge.addon.shell.aesh

Class ShellSingleCommand

java.lang.Object

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

org.jboss.forge.addon.shell.aesh.ShellSingleCommand

All Implemented Interfaces:

Comparable<AbstractShellInteraction>

public class ShellSingleCommand
extends AbstractShellInteraction

Encapsulates a UICommand to be useful in a Shell context

Author:

Ståle W. Pedersen, George Gastaldi, Lincoln Baxter, III

Field Summary

Fields inherited from class org.jboss.forge.addon.shell.aesh.AbstractShellInteraction

commandLineUtil

Constructor Summary

Constructors

Constructor and Description
ShellSingleCommand(org.jboss.forge.addon.ui.UICommand command, ShellContext shellContext, CommandLineUtil commandLineUtil) Creates a new ShellSingleCommand based on the shell and initial selection

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.forge.addon.ui.result.Result	execute()
org.jboss.forge.addon.ui.UICommand	getCommand()
List<String>	getCompletionOptions(String typed, String line)
Map<String,org.jboss.forge.addon.ui.input.InputComponent<?,Object>>	getInputs()
org.jboss.aesh.cl.parser.ParsedCompleteObject	parseCompleteObject(String line)
void	populateInputs(String line, boolean lenient)
List<String>	validate() Returns the error messages

Methods inherited from class org.jboss.forge.addon.shell.aesh.AbstractShellInteraction

buildInputs, compareTo, equals, getContext, getName, getSourceCommand, hashCode, removeExistingOptions, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellSingleCommand

public ShellSingleCommand(org.jboss.forge.addon.ui.UICommand command,
                  ShellContext shellContext,
                  CommandLineUtil commandLineUtil)

Creates a new ShellSingleCommand based on the shell and initial selection

Method Detail

getCommand

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

getInputs

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

Specified by:

getInputs in class AbstractShellInteraction

getCompletionOptions

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

Specified by:

getCompletionOptions in class AbstractShellInteraction

parseCompleteObject

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

Specified by:

parseCompleteObject in class AbstractShellInteraction

Throws:

org.jboss.aesh.cl.exception.CommandLineParserException

populateInputs

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

Specified by:

populateInputs in class AbstractShellInteraction

Throws:

org.jboss.aesh.cl.exception.CommandLineParserException

execute

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

Specified by:

execute in class AbstractShellInteraction

Throws:

Exception

validate

public List<String> validate()

Description copied from class: AbstractShellInteraction

Returns the error messages

Specified by:

validate in class AbstractShellInteraction

Returns: