com.mcdermottroe.exemplar
Interface Constants.UI.CLI

Enclosing interface:

Constants.UI

public static interface Constants.UI.CLI

CLI UI constants.

Field Summary

static String	ARG_ARG The key for the string that is displayed as the argument to an Argument description.
static int	DEFAULT_TERMINAL_WIDTH The width of a "standard" terminal.
static String	ENUM_ARG The key for the string that is displayed as the argument to an Enum description.
static String	EXIT_FAIL_ARGS The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while processing the command line arguments.
static String	EXIT_FAIL_CODE_GEN The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while generating the output.
static String	EXIT_FAIL_INPUT The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while processing the input.
static String	EXIT_FAIL_L10N The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error in the localisation (L10N) phase.
static String	EXIT_SUCCESS The mnemonic for use with ExitStatus to indicate that the program has terminated without encountering any error.
static String	HELP_OPTION_NAME The name of the option which produces the usage message.
static String	OPTION_PREFIX The prefix for all command line options.
static String	OPTIONS_LINE The key for the string that describe the options.
static String	USAGE_LINE_MSG_FMT The key for the message format that makes up the usage line.
static String	VERBOSE_OPTION_NAME The name of the option which causes the program to be more verbose.
static String	VERSION_OPTION_NAME The name of the option which produces the version message.

Field Detail

DEFAULT_TERMINAL_WIDTH

static final int DEFAULT_TERMINAL_WIDTH

The width of a "standard" terminal. One day there may be smart terminal width detection code, but for now it is assumed that all users of the CLI interface have a terminal 80 characters wide or wider.

See Also:

Constant Field Values

EXIT_SUCCESS

static final String EXIT_SUCCESS

The mnemonic for use with ExitStatus to indicate that the program has terminated without encountering any error.

See Also:

Constant Field Values

EXIT_FAIL_L10N

static final String EXIT_FAIL_L10N

The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error in the localisation (L10N) phase.

See Also:

Constant Field Values

EXIT_FAIL_ARGS

static final String EXIT_FAIL_ARGS

The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while processing the command line arguments.

See Also:

Constant Field Values

EXIT_FAIL_INPUT

static final String EXIT_FAIL_INPUT

The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while processing the input.

See Also:

Constant Field Values

EXIT_FAIL_CODE_GEN

static final String EXIT_FAIL_CODE_GEN

The mnemonic for use with ExitStatus to indicate that the program has terminated due to an error encountered while generating the output.

See Also:

Constant Field Values

ARG_ARG

static final String ARG_ARG

The key for the string that is displayed as the argument to an Argument description.

See Also:

Constant Field Values

ENUM_ARG

static final String ENUM_ARG

The key for the string that is displayed as the argument to an Enum description.

See Also:

Constant Field Values

OPTIONS_LINE

static final String OPTIONS_LINE

The key for the string that describe the options.

See Also:

Constant Field Values

USAGE_LINE_MSG_FMT

static final String USAGE_LINE_MSG_FMT

The key for the message format that makes up the usage line.

See Also:

Constant Field Values

HELP_OPTION_NAME

static final String HELP_OPTION_NAME

The name of the option which produces the usage message.

See Also:

Constant Field Values

VERBOSE_OPTION_NAME

static final String VERBOSE_OPTION_NAME

The name of the option which causes the program to be more verbose.

See Also:

Constant Field Values

VERSION_OPTION_NAME

static final String VERSION_OPTION_NAME

The name of the option which produces the version message.

See Also:

Constant Field Values

OPTION_PREFIX

static final String OPTION_PREFIX

The prefix for all command line options. The UNIX convention is used here. Perhaps in future there can be some platform checking magic to change this to the conventional form for the local platform? Would this break cross-platform wrappers?

See Also:

Constant Field Values