CommandRegistration.OptionSpec (Spring Shell Documentation 2.1.17 API)

All Known Implementing Classes:

CommandRegistration.DefaultOptionSpec

Enclosing interface:

CommandRegistration
```
public static interface CommandRegistration.OptionSpec
```
Spec defining an option.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CommandRegistration.Builder`	`and()` Return a builder for chaining.
`CommandRegistration.OptionSpec`	`arity(CommandRegistration.OptionArity arity)` Define an `arity` for an option.
`CommandRegistration.OptionSpec`	`arity(int min, int max)` Define an `arity` for an option.
`CommandRegistration.OptionSpec`	`completion(CompletionResolver completion)` Define a `completion function` for an option.
`CommandRegistration.OptionSpec`	`defaultValue(String defaultValue)` Define a `defaultValue` for an option.
`CommandRegistration.OptionSpec`	`description(String description)` Define a `description` for an option.
`CommandRegistration.OptionSpec`	`label(String label)` Define a `label` for an option.
`CommandRegistration.OptionSpec`	`longNames(String... names)` Define long option names.
`CommandRegistration.OptionSpec`	`position(Integer position)` Define an optional hint for possible positional mapping.
`CommandRegistration.OptionSpec`	`required()` Define option to be required.
`CommandRegistration.OptionSpec`	`required(boolean required)` Define if option is required.
`CommandRegistration.OptionSpec`	`shortNames(Character... names)` Define short option names.
`CommandRegistration.OptionSpec`	`type(org.springframework.core.ResolvableType type)` Define a `ResolvableType` for an option.
`CommandRegistration.OptionSpec`	`type(Type type)` Define a type for an option.

- Method Detail
  - longNames
```
CommandRegistration.OptionSpec longNames(String... names)
```
    Define long option names.
    
    Parameters:
    
    names - the long option names
    
    Returns:
    
    option spec for chaining
  - shortNames
```
CommandRegistration.OptionSpec shortNames(Character... names)
```
    Define short option names.
    
    Parameters:
    
    names - the long option names
    
    Returns:
    
    option spec for chaining
  - type
```
CommandRegistration.OptionSpec type(Type type)
```
    Define a type for an option. This method is a shortcut for type(ResolvableType) which is a preferred way to define type with generics. Will override one from type(ResolvableType).
    
    Parameters:
    
    type - the type
    
    Returns:
    
    option spec for chaining
    
    See Also:
    
    type(ResolvableType)
  - type
```
CommandRegistration.OptionSpec type(org.springframework.core.ResolvableType type)
```
    Define a ResolvableType for an option. This method is a preferred way to define type with generics. Will override one from type(Type).
    
    Parameters:
    
    type - the resolvable type
    
    Returns:
    
    option spec for chaining
  - description
```
CommandRegistration.OptionSpec description(String description)
```
    Define a description for an option.
    
    Parameters:
    
    description - the option description
    
    Returns:
    
    option spec for chaining
  - required
```
CommandRegistration.OptionSpec required(boolean required)
```
    Define if option is required.
    
    Parameters:
    
    required - the required flag
    
    Returns:
    
    option spec for chaining
  - required
```
CommandRegistration.OptionSpec required()
```
    Define option to be required. Syntatic sugar calling required(boolean) with true.
    
    Returns:
    
    option spec for chaining
  - defaultValue
```
CommandRegistration.OptionSpec defaultValue(String defaultValue)
```
    Define a defaultValue for an option.
    
    Parameters:
    
    defaultValue - the option default value
    
    Returns:
    
    option spec for chaining
  - position
```
CommandRegistration.OptionSpec position(Integer position)
```
    Define an optional hint for possible positional mapping.
    
    Parameters:
    
    position - the position
    
    Returns:
    
    option spec for chaining
  - arity
```
CommandRegistration.OptionSpec arity(int min,
                                     int max)
```
    Define an arity for an option.
    
    Parameters:
    
    min - the min arity
    
    max - the max arity
    
    Returns:
    
    option spec for chaining
  - arity
```
CommandRegistration.OptionSpec arity(CommandRegistration.OptionArity arity)
```
    Define an arity for an option.
    
    Parameters:
    
    arity - the arity
    
    Returns:
    
    option spec for chaining
  - label
```
CommandRegistration.OptionSpec label(String label)
```
    Define a label for an option.
    
    Parameters:
    
    label - the label
    
    Returns:
    
    option spec for chaining
  - completion
```
CommandRegistration.OptionSpec completion(CompletionResolver completion)
```
    Define a completion function for an option.
    
    Parameters:
    
    completion - the completion function
    
    Returns:
    
    option spec for chaining
  - and
```
CommandRegistration.Builder and()
```
    Return a builder for chaining.
    
    Returns:
    
    a builder for chaining

Interface CommandRegistration.OptionSpec

Method Summary

Method Detail

longNames

shortNames

type

type

description

required

required

defaultValue

position

arity

arity

label

completion

and