Package org.springframework.shell.command

Class CommandRegistration.DefaultCommandRegistration

java.lang.Object

org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

All Implemented Interfaces:

CommandRegistration

Enclosing interface:

CommandRegistration

public static class CommandRegistration.DefaultCommandRegistration
extends Object
implements CommandRegistration

Nested Class Summary

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

CommandRegistration.AliasSpec, CommandRegistration.BaseBuilder, CommandRegistration.Builder, CommandRegistration.BuilderSupplier, CommandRegistration.DefaultAliasSpec, CommandRegistration.DefaultBuilder, CommandRegistration.DefaultCommandRegistration, CommandRegistration.DefaultErrorHandlingSpec, CommandRegistration.DefaultExitCodeSpec, CommandRegistration.DefaultHelpOptionsSpec, CommandRegistration.DefaultOptionSpec, CommandRegistration.DefaultTargetSpec, CommandRegistration.ErrorHandlingSpec, CommandRegistration.ExitCodeSpec, CommandRegistration.HelpOptionInfo, CommandRegistration.HelpOptionsSpec, CommandRegistration.OptionArity, CommandRegistration.OptionNameModifier, CommandRegistration.OptionSpec, CommandRegistration.TargetInfo, CommandRegistration.TargetSpec

Constructor Summary

Constructors

Constructor

Description

DefaultCommandRegistration(String[] commands, InteractionMode interactionMode, String group, boolean hidden, String description, Supplier<Availability> availability, List<CommandRegistration.DefaultOptionSpec> optionSpecs, CommandRegistration.DefaultTargetSpec targetSpec, List<CommandRegistration.DefaultAliasSpec> aliasSpecs, CommandRegistration.DefaultExitCodeSpec exitCodeSpec, CommandRegistration.DefaultErrorHandlingSpec errorHandlingSpec, CommandRegistration.DefaultHelpOptionsSpec helpOptionsSpec)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCommandRegistration

public DefaultCommandRegistration(String[] commands,
 InteractionMode interactionMode,
 String group,
 boolean hidden,
 String description,
 Supplier<Availability> availability,
 List<CommandRegistration.DefaultOptionSpec> optionSpecs,
 CommandRegistration.DefaultTargetSpec targetSpec,
 List<CommandRegistration.DefaultAliasSpec> aliasSpecs,
 CommandRegistration.DefaultExitCodeSpec exitCodeSpec,
 CommandRegistration.DefaultErrorHandlingSpec errorHandlingSpec,
 CommandRegistration.DefaultHelpOptionsSpec helpOptionsSpec)

Method Details

getCommand

public String getCommand()

Description copied from interface: CommandRegistration

Gets a command for this registration.

Specified by:

getCommand in interface CommandRegistration

Returns:

command

getInteractionMode

public InteractionMode getInteractionMode()

Description copied from interface: CommandRegistration

Gets an InteractionMode.

Specified by:

getInteractionMode in interface CommandRegistration

Returns:

the interaction mode

getGroup

public String getGroup()

Description copied from interface: CommandRegistration

Get group for a command.

Specified by:

getGroup in interface CommandRegistration

Returns:

the group

isHidden

public boolean isHidden()

Description copied from interface: CommandRegistration

Returns if command is hidden.

Specified by:

isHidden in interface CommandRegistration

Returns:

true if command is hidden

getDescription

public String getDescription()

Description copied from interface: CommandRegistration

Get description for a command.

Specified by:

getDescription in interface CommandRegistration

Returns:

the description

getAvailability

public Availability getAvailability()

Description copied from interface: CommandRegistration

Get Availability for a command

Specified by:

getAvailability in interface CommandRegistration

Returns:

the availability

getOptions

public List<CommandOption> getOptions()

Description copied from interface: CommandRegistration

Gets an options.

Specified by:

getOptions in interface CommandRegistration

Returns:

the options

getTarget

public CommandRegistration.TargetInfo getTarget()

Description copied from interface: CommandRegistration

Gets target info.

Specified by:

getTarget in interface CommandRegistration

Returns:

the target info

getAliases

public List<CommandAlias> getAliases()

Description copied from interface: CommandRegistration

Gets an aliases.

Specified by:

getAliases in interface CommandRegistration

Returns:

the aliases

getExitCode

public CommandExitCode getExitCode()

Description copied from interface: CommandRegistration

Gets an exit code.

Specified by:

getExitCode in interface CommandRegistration

Returns:

the exit code

getExceptionResolvers

public List<CommandExceptionResolver> getExceptionResolvers()

Description copied from interface: CommandRegistration

Gets an exception resolvers.

Specified by:

getExceptionResolvers in interface CommandRegistration

Returns:

the exception resolvers

getHelpOption

public CommandRegistration.HelpOptionInfo getHelpOption()

Description copied from interface: CommandRegistration

Gets a help option info.

Specified by:

getHelpOption in interface CommandRegistration

Returns:

the help option info