org.springframework.shell

Interface ParameterResolver

All Known Implementing Classes:

JCommanderParameterResolver, LegacyParameterResolver, StandardParameterResolver

public interface ParameterResolver

Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.

An order can also be specified in case more than one ParameterResolver supports a MethodParameter. See AnnotationAwareOrderComparator for details..

Author:

Eric Bottard, Camilo Gonzalez

Method Summary

Modifier and Type	Method and Description
List<CompletionProposal>	complete(org.springframework.core.MethodParameter parameter, 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> words) Turn the given textual input into an actual object, maybe using some conversion or lookup mechanism.
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).

Method Detail

supports

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).

resolve

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

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

describe

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

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).

complete

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

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.