org.springframework.shell.command

Class CommandOption.DefaultCommandOption

java.lang.Object

org.springframework.shell.command.CommandOption.DefaultCommandOption

All Implemented Interfaces:

CommandOption

Enclosing interface:

CommandOption

public static class CommandOption.DefaultCommandOption
extends Object
implements CommandOption

Default implementation of CommandOption.

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.command.CommandOption

CommandOption.DefaultCommandOption

Constructor Summary

Constructors

Constructor and Description
DefaultCommandOption(String[] longNames, Character[] shortNames, String description, org.springframework.core.ResolvableType type, boolean required, String defaultValue, Integer position, Integer arityMin, Integer arityMax, String label, CompletionResolver completion)

Method Summary

Modifier and Type	Method and Description
int	getArityMax() Gets a maximum arity.
int	getArityMin() Gets a minimum arity.
CompletionResolver	getCompletion() Gets a completion function.
String	getDefaultValue() Gets a default value of an option.
String	getDescription() Gets a description of an option.
String	getLabel() Gets a label.
String[]	getLongNames() Gets a long names of an option.
int	getPosition() Gets a positional value.
Character[]	getShortNames() Gets a short names of an option.
org.springframework.core.ResolvableType	getType() Gets a ResolvableType of an option.
boolean	isRequired() Gets a flag if option is required.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.shell.command.CommandOption

of, of, of

Constructor Detail

DefaultCommandOption

public DefaultCommandOption(String[] longNames,
                            Character[] shortNames,
                            String description,
                            org.springframework.core.ResolvableType type,
                            boolean required,
                            String defaultValue,
                            Integer position,
                            Integer arityMin,
                            Integer arityMax,
                            String label,
                            CompletionResolver completion)

Method Detail

getLongNames

public String[] getLongNames()

Description copied from interface: CommandOption

Gets a long names of an option.

Specified by:

getLongNames in interface CommandOption

Returns:

long names of an option

getShortNames

public Character[] getShortNames()

Description copied from interface: CommandOption

Gets a short names of an option.

Specified by:

getShortNames in interface CommandOption

Returns:

short names of an option

getDescription

public String getDescription()

Description copied from interface: CommandOption

Gets a description of an option.

Specified by:

getDescription in interface CommandOption

Returns:

description of an option

getType

public org.springframework.core.ResolvableType getType()

Description copied from interface: CommandOption

Gets a ResolvableType of an option.

Specified by:

getType in interface CommandOption

Returns:

type of an option

isRequired

public boolean isRequired()

Description copied from interface: CommandOption

Gets a flag if option is required.

Specified by:

isRequired in interface CommandOption

Returns:

the required flag

getDefaultValue

public String getDefaultValue()

Description copied from interface: CommandOption

Gets a default value of an option.

Specified by:

getDefaultValue in interface CommandOption

Returns:

the default value

getPosition

public int getPosition()

Description copied from interface: CommandOption

Gets a positional value.

Specified by:

getPosition in interface CommandOption

Returns:

the positional value

getArityMin

public int getArityMin()

Description copied from interface: CommandOption

Gets a minimum arity.

Specified by:

getArityMin in interface CommandOption

Returns:

the minimum arity

getArityMax

public int getArityMax()

Description copied from interface: CommandOption

Gets a maximum arity.

Specified by:

getArityMax in interface CommandOption

Returns:

the maximum arity

getLabel

public String getLabel()

Description copied from interface: CommandOption

Gets a label.

Specified by:

getLabel in interface CommandOption

Returns:

the label

getCompletion

public CompletionResolver getCompletion()

Description copied from interface: CommandOption

Gets a completion function.

Specified by:

getCompletion in interface CommandOption

Returns:

the completion function