org.springframework.shell.jcommander

Class JCommanderParameterResolver

java.lang.Object

org.springframework.shell.jcommander.JCommanderParameterResolver

All Implemented Interfaces:

ParameterResolver

public class JCommanderParameterResolver
extends Object
implements ParameterResolver

Provides integration with JCommander.

Author:

Eric Bottard, Josh Long

Constructor Summary

Constructors

Constructor and Description
JCommanderParameterResolver()

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.
void	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)
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

JCommanderParameterResolver

public JCommanderParameterResolver()

Method Detail

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

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 parameter,
                                         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