Package org.springframework.shell.command

Interface CommandRegistration

All Known Implementing Classes:

CommandRegistration.DefaultCommandRegistration

public interface CommandRegistration

Interface defining a command registration endpoint.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CommandRegistration.AliasSpec	Spec defining an alias.
static class	CommandRegistration.BaseBuilder
static interface	CommandRegistration.Builder	Builder interface for CommandRegistration.
static interface	CommandRegistration.BuilderSupplier	Interface used to supply instance of a CommandRegistration.Builder.
static class	CommandRegistration.DefaultAliasSpec
static class	CommandRegistration.DefaultBuilder
static class	CommandRegistration.DefaultCommandRegistration
static class	CommandRegistration.DefaultErrorHandlingSpec
static class	CommandRegistration.DefaultExitCodeSpec
static class	CommandRegistration.DefaultHelpOptionsSpec
static class	CommandRegistration.DefaultOptionSpec
static class	CommandRegistration.DefaultTargetSpec
static interface	CommandRegistration.ErrorHandlingSpec	Spec defining an error handling.
static interface	CommandRegistration.ExitCodeSpec	Spec defining an exit code.
static interface	CommandRegistration.HelpOptionInfo
static interface	CommandRegistration.HelpOptionsSpec	Spec defining help options.
static enum	CommandRegistration.OptionArity	Enumeration of option arity values.
static interface	CommandRegistration.OptionNameModifier	Interface used to modify option long name.
static interface	CommandRegistration.OptionSpec	Spec defining an option.
static interface	CommandRegistration.TargetInfo	Encapsulates info for CommandRegistration.TargetSpec.
static interface	CommandRegistration.TargetSpec	Spec defining a target.

Method Summary

Modifier and Type	Method	Description
static CommandRegistration.Builder	builder()	Gets a new instance of a CommandRegistration.Builder.
List<CommandAlias>	getAliases()	Gets an aliases.
Availability	getAvailability()	Get Availability for a command
String	getCommand()	Gets a command for this registration.
String	getDescription()	Get description for a command.
List<CommandExceptionResolver>	getExceptionResolvers()	Gets an exception resolvers.
CommandExitCode	getExitCode()	Gets an exit code.
String	getGroup()	Get group for a command.
CommandRegistration.HelpOptionInfo	getHelpOption()	Gets a help option info.
InteractionMode	getInteractionMode()	Gets an InteractionMode.
List<CommandOption>	getOptions()	Gets an options.
CommandRegistration.TargetInfo	getTarget()	Gets target info.
boolean	isHidden()	Returns if command is hidden.

Method Details

getCommand

String getCommand()

Gets a command for this registration.

Returns:

command

getInteractionMode

InteractionMode getInteractionMode()

Gets an InteractionMode.

Returns:

the interaction mode

getGroup

String getGroup()

Get group for a command.

Returns:

the group

isHidden

boolean isHidden()

Returns if command is hidden.

Returns:

true if command is hidden

getDescription

String getDescription()

Get description for a command.

Returns:

the description

getAvailability

Availability getAvailability()

Get Availability for a command

Returns:

the availability

getTarget

CommandRegistration.TargetInfo getTarget()

Gets target info.

Returns:

the target info

getOptions

List<CommandOption> getOptions()

Gets an options.

Returns:

the options

getAliases

List<CommandAlias> getAliases()

Gets an aliases.

Returns:

the aliases

getExitCode

CommandExitCode getExitCode()

Gets an exit code.

Returns:

the exit code

getExceptionResolvers

List<CommandExceptionResolver> getExceptionResolvers()

Gets an exception resolvers.

Returns:

the exception resolvers

getHelpOption

CommandRegistration.HelpOptionInfo getHelpOption()

Gets a help option info.

Returns:

the help option info

builder

static CommandRegistration.Builder builder()

Gets a new instance of a CommandRegistration.Builder.

Returns:

a new builder instance