Package org.springframework.shell.command

Class CommandRegistration.DefaultHelpOptionsSpec

java.lang.Object

org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec

All Implemented Interfaces:

CommandRegistration.HelpOptionsSpec

Enclosing interface:

CommandRegistration

public static class CommandRegistration.DefaultHelpOptionsSpec
extends Object
implements CommandRegistration.HelpOptionsSpec

Method Summary

Modifier and Type	Method	Description
CommandRegistration.Builder	and()	Return a builder for chaining.
CommandRegistration.HelpOptionsSpec	command(String command)	Sets command used for help.
CommandRegistration.HelpOptionsSpec	enabled(boolean enabled)	Whether help options are enabled.
CommandRegistration.HelpOptionsSpec	longNames(String... longNames)	Sets long names options for help.
CommandRegistration.HelpOptionsSpec	shortNames(Character... shortNames)	Sets short names options for help.

Methods inherited from class java.lang.Object

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

Method Details

command

public CommandRegistration.HelpOptionsSpec command(String command)

Description copied from interface: CommandRegistration.HelpOptionsSpec

Sets command used for help.

Specified by:

command in interface CommandRegistration.HelpOptionsSpec

Parameters:

command - the command

Returns:

a help option for chaining

longNames

public CommandRegistration.HelpOptionsSpec longNames(String... longNames)

Description copied from interface: CommandRegistration.HelpOptionsSpec

Sets long names options for help.

Specified by:

longNames in interface CommandRegistration.HelpOptionsSpec

Parameters:

longNames - the long names

Returns:

a help option for chaining

shortNames

public CommandRegistration.HelpOptionsSpec shortNames(Character... shortNames)

Description copied from interface: CommandRegistration.HelpOptionsSpec

Sets short names options for help.

Specified by:

shortNames in interface CommandRegistration.HelpOptionsSpec

Parameters:

shortNames - the short names

Returns:

a help option for chaining

enabled

public CommandRegistration.HelpOptionsSpec enabled(boolean enabled)

Description copied from interface: CommandRegistration.HelpOptionsSpec

Whether help options are enabled.

Specified by:

enabled in interface CommandRegistration.HelpOptionsSpec

Parameters:

enabled - the enabled flag

Returns:

a help option for chaining

and

public CommandRegistration.Builder and()

Description copied from interface: CommandRegistration.HelpOptionsSpec

Return a builder for chaining.

Specified by:

and in interface CommandRegistration.HelpOptionsSpec

Returns:

a builder for chaining