Package org.springframework.shell.command

Class CommandRegistration.BaseBuilder

java.lang.Object

org.springframework.shell.command.CommandRegistration.BaseBuilder

All Implemented Interfaces:

CommandRegistration.Builder

Direct Known Subclasses:

CommandRegistration.DefaultBuilder

Enclosing interface:

CommandRegistration

public abstract static class CommandRegistration.BaseBuilder
extends Object
implements CommandRegistration.Builder

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()

Method Summary

Modifier and Type	Method	Description
CommandRegistration.Builder	availability(Supplier<Availability> availability)	Define an Availability suppliear for a command.
CommandRegistration	build()	Builds a CommandRegistration.
CommandRegistration.Builder	command(String... commands)	Define commands this registration uses.
CommandRegistration.Builder	defaultOptionNameModifier(Function<String,String> modifier)	Provides a global option name modifier.
CommandRegistration.Builder	description(String description)	Define a description text for a command.
CommandRegistration.Builder	group(String group)	Define a group for a command.
CommandRegistration.Builder	hidden()	Define a command to be hidden.
CommandRegistration.Builder	hidden(boolean hidden)	Define a command to be hidden by a given flag.
CommandRegistration.Builder	interactionMode(InteractionMode mode)	Define InteractionMode for a command.
CommandRegistration.AliasSpec	withAlias()	Define an alias what this command should execute
CommandRegistration.ErrorHandlingSpec	withErrorHandling()	Define an error handling what this command should use
CommandRegistration.ExitCodeSpec	withExitCode()	Define an exit code what this command should execute
CommandRegistration.HelpOptionsSpec	withHelpOptions()	Define help options what this command should use.
CommandRegistration.OptionSpec	withOption()	Define an option what this command should user for.
CommandRegistration.TargetSpec	withTarget()	Define a target what this command should execute

Methods inherited from class java.lang.Object

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

Constructor Details

BaseBuilder

public BaseBuilder()

Method Details

command

public CommandRegistration.Builder command(String... commands)

Description copied from interface: CommandRegistration.Builder

Define commands this registration uses. Essentially defines a full set of main and sub commands. It doesn't matter if full command is defined in one string or multiple strings as "words" are splitted and trimmed with whitespaces. You will get result of command subcommand1 subcommand2, ....

Specified by:

command in interface CommandRegistration.Builder

Parameters:

commands - the commands

Returns:

builder for chaining

interactionMode

public CommandRegistration.Builder interactionMode(InteractionMode mode)

Description copied from interface: CommandRegistration.Builder

Define InteractionMode for a command.

Specified by:

interactionMode in interface CommandRegistration.Builder

Parameters:

mode - the interaction mode

Returns:

builder for chaining

description

public CommandRegistration.Builder description(String description)

Description copied from interface: CommandRegistration.Builder

Define a description text for a command.

Specified by:

description in interface CommandRegistration.Builder

Parameters:

description - the description text

Returns:

builder for chaining

group

public CommandRegistration.Builder group(String group)

Description copied from interface: CommandRegistration.Builder

Define a group for a command.

Specified by:

group in interface CommandRegistration.Builder

Parameters:

group - the group

Returns:

builder for chaining

hidden

public CommandRegistration.Builder hidden()

Description copied from interface: CommandRegistration.Builder

Define a command to be hidden.

Specified by:

hidden in interface CommandRegistration.Builder

Returns:

builder for chaining

See Also:

• CommandRegistration.Builder.hidden(boolean)

hidden

public CommandRegistration.Builder hidden(boolean hidden)

Description copied from interface: CommandRegistration.Builder

Define a command to be hidden by a given flag.

Specified by:

hidden in interface CommandRegistration.Builder

Parameters:

hidden - the hidden flag

Returns:

builder for chaining

availability

public CommandRegistration.Builder availability(Supplier<Availability> availability)

Description copied from interface: CommandRegistration.Builder

Define an Availability suppliear for a command.

Specified by:

availability in interface CommandRegistration.Builder

Parameters:

availability - the availability

Returns:

builder for chaining

defaultOptionNameModifier

public CommandRegistration.Builder defaultOptionNameModifier(Function<String,String> modifier)

Description copied from interface: CommandRegistration.Builder

Provides a global option name modifier. Will be used with all options to modify long names. Usual use case is to enforce naming convention i.e. to have snake-case for all names.

Specified by:

defaultOptionNameModifier in interface CommandRegistration.Builder

Parameters:

modifier - to modifier to change option name

Returns:

builder for chaining

withOption

public CommandRegistration.OptionSpec withOption()

Description copied from interface: CommandRegistration.Builder

Define an option what this command should user for. Can be used multiple times.

Specified by:

withOption in interface CommandRegistration.Builder

Returns:

option spec for chaining

withTarget

public CommandRegistration.TargetSpec withTarget()

Description copied from interface: CommandRegistration.Builder

Define a target what this command should execute

Specified by:

withTarget in interface CommandRegistration.Builder

Returns:

target spec for chaining

withAlias

public CommandRegistration.AliasSpec withAlias()

Description copied from interface: CommandRegistration.Builder

Define an alias what this command should execute

Specified by:

withAlias in interface CommandRegistration.Builder

Returns:

alias spec for chaining

withExitCode

public CommandRegistration.ExitCodeSpec withExitCode()

Description copied from interface: CommandRegistration.Builder

Define an exit code what this command should execute

Specified by:

withExitCode in interface CommandRegistration.Builder

Returns:

exit code spec for chaining

withErrorHandling

public CommandRegistration.ErrorHandlingSpec withErrorHandling()

Description copied from interface: CommandRegistration.Builder

Define an error handling what this command should use

Specified by:

withErrorHandling in interface CommandRegistration.Builder

Returns:

error handling spec for chaining

withHelpOptions

public CommandRegistration.HelpOptionsSpec withHelpOptions()

Description copied from interface: CommandRegistration.Builder

Define help options what this command should use.

Specified by:

withHelpOptions in interface CommandRegistration.Builder

Returns:

help options spec for chaining

build

public CommandRegistration build()

Description copied from interface: CommandRegistration.Builder

Builds a CommandRegistration.

Specified by:

build in interface CommandRegistration.Builder

Returns:

a command registration