org.springframework.shell.standard

Class StandardParameterResolver

java.lang.Object

org.springframework.shell.standard.StandardParameterResolver

All Implemented Interfaces:

ParameterResolver

@Component
public class StandardParameterResolver
extends Object
implements ParameterResolver

Default ParameterResolver implementation that supports the following features:

• named parameters (recognized because they start with some ShellMethod.prefix())
• implicit named parameters (from the actual method parameter name)
• positional parameters (in order, for all parameter values that were not resolved via named parameters)
• default values (for all remaining parameters)

Method arguments can consume several words of input at once (driven by ShellOption.arity(), default 1). If several words are consumed, they will be joined together as a comma separated value and passed to the ConversionService (which will typically return a List or array).

Boolean parameters are by default expected to have an arity of 0, allowing invocations in the form rm --force --dir /foo: the presence of --force passes true as a parameter value, while its absence passes false. Both the default arity of 0 and the default value of false can be overridden via ShellOption if needed.

Author:

Eric Bottard, Florent Biville, Camilo Gonzalez

Constructor Summary

Constructors

Constructor and Description
StandardParameterResolver(org.springframework.core.convert.ConversionService conversionService)

Method Summary

Modifier and Type	Method and Description
List<CompletionProposal>	complete(org.springframework.core.MethodParameter methodParameter, CompletionContext context) Invoked during TAB completion.
Stream<ParameterDescription>	describe(org.springframework.core.MethodParameter parameter) Describe a supported parameter, so that integrated help can be generated.
ValueResult	resolve(org.springframework.core.MethodParameter methodParameter, List<String> wordsBuffer) Turn the given textual input into an actual object, maybe using some conversion or lookup mechanism.
void	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)
void	setValueProviders(Collection<ValueProvider> valueProviders)
boolean	supports(org.springframework.core.MethodParameter parameter) Should return true if this resolver recognizes the given method parameter (e.g. it has the correct annotation or the correct type).

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardParameterResolver

@Autowired
public StandardParameterResolver(org.springframework.core.convert.ConversionService conversionService)

Method Detail

setValueProviders

@Autowired(required=false)
public void setValueProviders(Collection<ValueProvider> valueProviders)

setValidatorFactory

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

supports

public boolean supports(org.springframework.core.MethodParameter parameter)

Description copied from interface: ParameterResolver

Should return true if this resolver recognizes the given method parameter (e.g. it has the correct annotation or the correct type).

Specified by:

supports in interface ParameterResolver

resolve

public ValueResult resolve(org.springframework.core.MethodParameter methodParameter,
                           List<String> wordsBuffer)

Description copied from interface: ParameterResolver

Turn the given textual input into an actual object, maybe using some conversion or lookup mechanism.

Specified by:

resolve in interface ParameterResolver

describe

public Stream<ParameterDescription> describe(org.springframework.core.MethodParameter parameter)

Description copied from interface: ParameterResolver

Describe a supported parameter, so that integrated help can be generated.

Typical implementations will return a one element stream result, but some may return several (for example if binding several words to a POJO).

Specified by:

describe in interface ParameterResolver

complete

public List<CompletionProposal> complete(org.springframework.core.MethodParameter methodParameter,
                                         CompletionContext context)

Description copied from interface: ParameterResolver

Invoked during TAB completion. If the CompletionContext can be interpreted as the start of a supported MethodParameter value, one or several proposals should be returned.

Specified by:

complete in interface ParameterResolver