Package org.springframework.shell.command

Interface CommandRegistration.HelpOptionInfo

All Known Implementing Classes:

CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo

Enclosing interface:

CommandRegistration

public static interface CommandRegistration.HelpOptionInfo

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo

Method Summary

Modifier and Type	Method	Description
String	getCommand()	Gets command for help.
String[]	getLongNames()	Gets long names options for help.
Character[]	getShortNames()	Gets short names options for help.
boolean	isEnabled()	Gets whether help options are enabled.
static CommandRegistration.HelpOptionInfo	of()
static CommandRegistration.HelpOptionInfo	of(boolean enabled, String[] longNames, Character[] shortNames, String command)

Method Details

isEnabled

boolean isEnabled()

Gets whether help options are enabled.

Returns:

whether help options are enabled

getLongNames

String[] getLongNames()

Gets long names options for help.

Returns:

long names options for help

getShortNames

Character[] getShortNames()

Gets short names options for help.

Returns:

short names options for help

getCommand

String getCommand()

Gets command for help.

Returns:

command for help

of

static CommandRegistration.HelpOptionInfo of()

of

static CommandRegistration.HelpOptionInfo of(boolean enabled,
 String[] longNames,
 Character[] shortNames,
 String command)