org.springframework.shell

Class Shell

java.lang.Object

org.springframework.shell.Shell

All Implemented Interfaces:

CommandRegistry

public class Shell
extends Object
implements CommandRegistry

Main class implementing a shell loop.

Given some textual input, locate the MethodTarget to invoke and handle the result.

Also provides hooks for code completion

Author:

Eric Bottard

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected Map<String,MethodTarget>	methodTargets
static Object	NO_INPUT Marker object returned to signify that there was no input to turn into a command execution.
protected List<ParameterResolver>	parameterResolvers
protected static Object	UNRESOLVED Marker object to distinguish unresolved arguments from null, which is a valid value.

Constructor Summary

Constructors

Constructor and Description
Shell(ResultHandler resultHandler)

Method Summary

Modifier and Type	Method and Description
List<CompletionProposal>	complete(CompletionContext context) Gather completion proposals given some (incomplete) input the user has already typed in.
Object	evaluate(Input input) Evaluate a single "line" of input from the user by trying to map words to a command and arguments.
void	gatherMethodTargets()
Map<String,MethodTarget>	listCommands() Return the mapping from command trigger keywords to implementation.
void	run(InputProvider inputProvider) The main program loop: acquire input, try to match it to a command and evaluate.
void	setParameterResolvers(List<ParameterResolver> resolvers)
void	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

Methods inherited from class java.lang.Object

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

Field Detail

NO_INPUT

public static final Object NO_INPUT

Marker object returned to signify that there was no input to turn into a command execution.

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

methodTargets

protected Map<String,MethodTarget> methodTargets

parameterResolvers

protected List<ParameterResolver> parameterResolvers

UNRESOLVED

protected static final Object UNRESOLVED

Marker object to distinguish unresolved arguments from null, which is a valid value.

Constructor Detail

Shell

public Shell(ResultHandler resultHandler)

Method Detail

setValidatorFactory

@Autowired(required=false)
public void setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

listCommands

public Map<String,MethodTarget> listCommands()

Description copied from interface: CommandRegistry

Return the mapping from command trigger keywords to implementation.

Specified by:

listCommands in interface CommandRegistry

gatherMethodTargets

@PostConstruct
public void gatherMethodTargets()
                                        throws Exception

Throws:

Exception

setParameterResolvers

@Autowired
public void setParameterResolvers(List<ParameterResolver> resolvers)

run

public void run(InputProvider inputProvider)
         throws IOException

The main program loop: acquire input, try to match it to a command and evaluate. Repeat until a ResultHandler causes the process to exit or there is no input.

This method has public visibility so that it can be invoked by actual commands (e.g. a script command).

Throws:

IOException

evaluate

public Object evaluate(Input input)

Evaluate a single "line" of input from the user by trying to map words to a command and arguments.

This method does not throw exceptions, it catches them and returns them as a regular result

complete

public List<CompletionProposal> complete(CompletionContext context)

Gather completion proposals given some (incomplete) input the user has already typed in. When and how this method is invoked is implementation specific and decided by the actual user interface.