Package org.springframework.shell.command

Interface CommandRegistration.HelpOptionsSpec

All Known Implementing Classes:

CommandRegistration.DefaultHelpOptionsSpec

Enclosing interface:

CommandRegistration

public static interface CommandRegistration.HelpOptionsSpec

Spec defining help options.

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.

Method Details

enabled

CommandRegistration.HelpOptionsSpec enabled(boolean enabled)

Whether help options are enabled.

Parameters:

enabled - the enabled flag

Returns:

a help option for chaining

longNames

CommandRegistration.HelpOptionsSpec longNames(String... longNames)

Sets long names options for help.

Parameters:

longNames - the long names

Returns:

a help option for chaining

shortNames

CommandRegistration.HelpOptionsSpec shortNames(Character... shortNames)

Sets short names options for help.

Parameters:

shortNames - the short names

Returns:

a help option for chaining

command

CommandRegistration.HelpOptionsSpec command(String command)

Sets command used for help.

Parameters:

command - the command

Returns:

a help option for chaining

and

CommandRegistration.Builder and()

Return a builder for chaining.

Returns:

a builder for chaining