org.drombler.commons.client.startup.main.cli

Interface CommandLineSwitch

All Known Implementing Classes:

AbstractCommandLineSwitch, InstallDirSwitch, UserDirSwitch

public interface CommandLineSwitch

A command line switch.

Method Summary

Modifier and Type	Method and Description
void	consumeSwitch(String commandLineSwitch, String[] followUpArgs) Consumes the switch.
String	getHelpText() Gets a help text for this switch.
int	getNumFollowUpArgs() Gets the number of follow-up args required for this switch.
boolean	supportsSwitch(String commandLineSwitch) Indicates if this switch supports the provided String switch.

Method Detail

supportsSwitch

boolean supportsSwitch(String commandLineSwitch)

Indicates if this switch supports the provided String switch.

Parameters:

commandLineSwitch - the command line switch

Returns:

true, if the switch is supported, else false

getNumFollowUpArgs

int getNumFollowUpArgs()

Gets the number of follow-up args required for this switch.

Returns:

the number of follow-up args required for this switch

consumeSwitch

void consumeSwitch(String commandLineSwitch,
                   String[] followUpArgs)

Consumes the switch.

Parameters:

commandLineSwitch - the command line switch

followUpArgs - the required follow-up args.

getHelpText

String getHelpText()

Gets a help text for this switch.

Returns:

a help text for this switch