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

Class UserDirSwitch

java.lang.Object

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

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

All Implemented Interfaces:

CommandLineSwitch

public class UserDirSwitch
extends AbstractCommandLineSwitch
implements CommandLineSwitch

The application user directory switch.

Usage: [--userdir <user-directory>]

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_DIR_SWITCH Switch for specifying the user directory.

Constructor Summary

Constructors

Constructor and Description
UserDirSwitch() Creates a new instance of this class.

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.
String	getUserDir() Gets the provided application user directory, if this switch was consumed, else null.

Methods inherited from class org.drombler.commons.client.startup.main.cli.AbstractCommandLineSwitch

checkConsumeSwitchArgs, supportsSwitch

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drombler.commons.client.startup.main.cli.CommandLineSwitch

supportsSwitch

Field Detail

USER_DIR_SWITCH

public static final String USER_DIR_SWITCH

Switch for specifying the user directory.

See Also:

Constant Field Values

Constructor Detail

UserDirSwitch

public UserDirSwitch()

Creates a new instance of this class.

Method Detail

getNumFollowUpArgs

public int getNumFollowUpArgs()

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

Specified by:

getNumFollowUpArgs in interface CommandLineSwitch

Returns:

the number of follow-up args required for this switch

consumeSwitch

public void consumeSwitch(String commandLineSwitch,
                          String[] followUpArgs)

Consumes the switch.

Specified by:

consumeSwitch in interface CommandLineSwitch

Parameters:

commandLineSwitch - the command line switch

followUpArgs - the required follow-up args.

getHelpText

public String getHelpText()

Gets a help text for this switch.

Specified by:

getHelpText in interface CommandLineSwitch

Returns:

a help text for this switch

getUserDir

public String getUserDir()

Gets the provided application user directory, if this switch was consumed, else null.

Returns:

the provided application user directory, if this switch was consumed, else null