@Documented @Retention(value=RUNTIME) @Target(value=PARAMETER) public @interface ShellOption
ShellMethod parameter.| Modifier and Type | Fields and Description | 
|---|---|
| static int | ARITY_USE_HEURISTICSMarker value to indicate that heuristics should be used to derive arity. | 
| static String | NONEUsed to indicate that there is no default value (i.e. parameter is mandatory). | 
| static String | NULLUsed to indicate that the default value is the value null, which is different from the fact that
 there is no default value. | 
| Modifier and Type | Optional Element and Description | 
|---|---|
| int | arityReturn the number of input "words" this parameter consumes. | 
| String | defaultValueThe textual (pre-conversion) value to assign to this parameter if no value is provided by the user. | 
| String | helpReturn a short description of the parameter. | 
| boolean | optOutUsed to indicate to the framework that the given parameter should NOT be resolved by
  StandardParameterResolver. | 
| String[] | valueThe key(s) by which this parameter can be referenced
 when using named parameters. | 
| Class<? extends ValueProvider> | valueProvider | 
public static final String NULL
public static final String NONE
public static final int ARITY_USE_HEURISTICS
public abstract String[] value
ShellMethod.prefix().public abstract int arity
public abstract String defaultValue
public abstract String help
public abstract Class<? extends ValueProvider> valueProvider
public abstract boolean optOut
StandardParameterResolver. This is useful if several implementations of
 org.springframework.shell.ParameterResolver are present, given that the standard one can work with no
 annotation at all.
 Note that this is not used anymore!StandardParameterResolver should not be used for this parameterCopyright © 2023. All rights reserved.