Package org.springframework.shell.command

Class CommandRegistration.DefaultOptionSpec

java.lang.Object

org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

All Implemented Interfaces:

CommandRegistration.OptionSpec

Enclosing interface:

CommandRegistration

public static class CommandRegistration.DefaultOptionSpec
extends Object
implements CommandRegistration.OptionSpec

Method Summary

Modifier and Type	Method	Description
CommandRegistration.Builder	and()	Return a builder for chaining.
CommandRegistration.OptionSpec	arity(int min, int max)	Define an arity for an option.
CommandRegistration.OptionSpec	arity(CommandRegistration.OptionArity arity)	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.
Integer	getArityMax()
Integer	getArityMin()
CompletionResolver	getCompletion()
String	getDefaultValue()
String	getDescription()
String	getLabel()
String[]	getLongNames()
Function<String,String>	getOptionNameModifier()
Integer	getPosition()
Character[]	getShortNames()
org.springframework.core.ResolvableType	getType()
boolean	isRequired()
CommandRegistration.OptionSpec	label(String label)	Define a label for an option.
CommandRegistration.OptionSpec	longNames(String... names)	Define long option names.
CommandRegistration.OptionSpec	nameModifier(Function<String,String> modifier)	Define an option name modifier.
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(Type type)	Define a type for an option.
CommandRegistration.OptionSpec	type(org.springframework.core.ResolvableType type)	Define a ResolvableType for an option.

Methods inherited from class java.lang.Object

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

Method Details

longNames

public CommandRegistration.OptionSpec longNames(String... names)

Description copied from interface: CommandRegistration.OptionSpec

Define long option names.

Specified by:

longNames in interface CommandRegistration.OptionSpec

Parameters:

names - the long option names

Returns:

option spec for chaining

shortNames

public CommandRegistration.OptionSpec shortNames(Character... names)

Description copied from interface: CommandRegistration.OptionSpec

Define short option names.

Specified by:

shortNames in interface CommandRegistration.OptionSpec

Parameters:

names - the long option names

Returns:

option spec for chaining

type

public CommandRegistration.OptionSpec type(Type type)

Description copied from interface: CommandRegistration.OptionSpec

Define a type for an option. This method is a shortcut for CommandRegistration.OptionSpec.type(ResolvableType) which is a preferred way to define type with generics. Will override one from CommandRegistration.OptionSpec.type(ResolvableType).

Specified by:

type in interface CommandRegistration.OptionSpec

Parameters:

type - the type

Returns:

option spec for chaining

See Also:

• CommandRegistration.OptionSpec.type(ResolvableType)

type

public CommandRegistration.OptionSpec type(org.springframework.core.ResolvableType type)

Description copied from interface: CommandRegistration.OptionSpec

Define a ResolvableType for an option. This method is a preferred way to define type with generics. Will override one from CommandRegistration.OptionSpec.type(Type).

Specified by:

type in interface CommandRegistration.OptionSpec

Parameters:

type - the resolvable type

Returns:

option spec for chaining

description

public CommandRegistration.OptionSpec description(String description)

Description copied from interface: CommandRegistration.OptionSpec

Define a description for an option.

Specified by:

description in interface CommandRegistration.OptionSpec

Parameters:

description - the option description

Returns:

option spec for chaining

required

public CommandRegistration.OptionSpec required(boolean required)

Description copied from interface: CommandRegistration.OptionSpec

Define if option is required.

Specified by:

required in interface CommandRegistration.OptionSpec

Parameters:

required - the required flag

Returns:

option spec for chaining

required

public CommandRegistration.OptionSpec required()

Description copied from interface: CommandRegistration.OptionSpec

Define option to be required. Syntatic sugar calling CommandRegistration.OptionSpec.required(boolean) with true.

Specified by:

required in interface CommandRegistration.OptionSpec

Returns:

option spec for chaining

defaultValue

public CommandRegistration.OptionSpec defaultValue(String defaultValue)

Description copied from interface: CommandRegistration.OptionSpec

Define a defaultValue for an option.

Specified by:

defaultValue in interface CommandRegistration.OptionSpec

Parameters:

defaultValue - the option default value

Returns:

option spec for chaining

position

public CommandRegistration.OptionSpec position(Integer position)

Description copied from interface: CommandRegistration.OptionSpec

Define an optional hint for possible positional mapping.

Specified by:

position in interface CommandRegistration.OptionSpec

Parameters:

position - the position

Returns:

option spec for chaining

arity

public CommandRegistration.OptionSpec arity(int min,
 int max)

Description copied from interface: CommandRegistration.OptionSpec

Define an arity for an option.

Specified by:

arity in interface CommandRegistration.OptionSpec

Parameters:

min - the min arity

max - the max arity

Returns:

option spec for chaining

arity

public CommandRegistration.OptionSpec arity(CommandRegistration.OptionArity arity)

Description copied from interface: CommandRegistration.OptionSpec

Define an arity for an option.

Specified by:

arity in interface CommandRegistration.OptionSpec

Parameters:

arity - the arity

Returns:

option spec for chaining

label

public CommandRegistration.OptionSpec label(String label)

Description copied from interface: CommandRegistration.OptionSpec

Define a label for an option.

Specified by:

label in interface CommandRegistration.OptionSpec

Parameters:

label - the label

Returns:

option spec for chaining

completion

public CommandRegistration.OptionSpec completion(CompletionResolver completion)

Description copied from interface: CommandRegistration.OptionSpec

Define a completion function for an option.

Specified by:

completion in interface CommandRegistration.OptionSpec

Parameters:

completion - the completion function

Returns:

option spec for chaining

nameModifier

public CommandRegistration.OptionSpec nameModifier(Function<String,String> modifier)

Description copied from interface: CommandRegistration.OptionSpec

Define an option name modifier.

Specified by:

nameModifier in interface CommandRegistration.OptionSpec

Parameters:

modifier - the option name modifier function

Returns:

option spec for chaining

and

public CommandRegistration.Builder and()

Description copied from interface: CommandRegistration.OptionSpec

Return a builder for chaining.

Specified by:

and in interface CommandRegistration.OptionSpec

Returns:

a builder for chaining

getLongNames

public String[] getLongNames()

getShortNames

public Character[] getShortNames()

getType

public org.springframework.core.ResolvableType getType()

getDescription

public String getDescription()

isRequired

public boolean isRequired()

getDefaultValue

public String getDefaultValue()

getPosition

public Integer getPosition()

getArityMin

public Integer getArityMin()

getArityMax

public Integer getArityMax()

getLabel

public String getLabel()

getCompletion

public CompletionResolver getCompletion()

getOptionNameModifier

@Nullable
public Function<String,String> getOptionNameModifier()