org.kohsuke.args4j.spi

Enum Messages

java.lang.Object

java.lang.Enum<Messages>

org.kohsuke.args4j.spi.Messages

All Implemented Interfaces:

Serializable, Comparable<Messages>, Localizable

public enum Messages
extends Enum<Messages>
implements Localizable

Author:

Kohsuke Kawaguchi

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT_META_EXPLICIT_BOOLEAN_OPTION_HANDLER
DEFAULT_META_FILE_OPTION_HANDLER
DEFAULT_META_INET_ADDRESS_OPTION_HANDLER
DEFAULT_META_MAC_ADDRESS_OPTION_HANDLER
DEFAULT_META_PATH_OPTION_HANDLER
DEFAULT_META_PATTERN_OPTION_HANDLER
DEFAULT_META_REST_OF_ARGUMENTS_HANDLER
DEFAULT_META_STRING_ARRAY_OPTION_HANDLER
DEFAULT_META_STRING_OPTION_HANDLER
DEFAULT_META_SUB_COMMAND_HANDLER
DEFAULT_META_URI_OPTION_HANDLER
DEFAULT_META_URL_OPTION_HANDLER
DEFAULT_META_UUID_OPTION_HANDLER
FORMAT_ERROR_FOR_MAP
ILLEGAL_BOOLEAN
ILLEGAL_CHAR
ILLEGAL_FIELD_SIGNATURE
ILLEGAL_IP_ADDRESS
ILLEGAL_LIST
ILLEGAL_MAC_ADDRESS
ILLEGAL_METHOD_SIGNATURE
ILLEGAL_OPERAND
ILLEGAL_PATH
ILLEGAL_PATTERN
ILLEGAL_UUID
MAP_HAS_NO_KEY

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Object... args) Format the implicitly given message by this object with the default locale.
String	formatWithLocale(Locale locale, Object... args) Format the implicitly given message by this object with the given locale.
static Messages	valueOf(String name) Returns the enum constant of this type with the specified name.
static Messages[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ILLEGAL_OPERAND

public static final Messages ILLEGAL_OPERAND

ILLEGAL_CHAR

public static final Messages ILLEGAL_CHAR

ILLEGAL_BOOLEAN

public static final Messages ILLEGAL_BOOLEAN

ILLEGAL_METHOD_SIGNATURE

public static final Messages ILLEGAL_METHOD_SIGNATURE

ILLEGAL_FIELD_SIGNATURE

public static final Messages ILLEGAL_FIELD_SIGNATURE

ILLEGAL_LIST

public static final Messages ILLEGAL_LIST

FORMAT_ERROR_FOR_MAP

public static final Messages FORMAT_ERROR_FOR_MAP

MAP_HAS_NO_KEY

public static final Messages MAP_HAS_NO_KEY

ILLEGAL_IP_ADDRESS

public static final Messages ILLEGAL_IP_ADDRESS

ILLEGAL_PATTERN

public static final Messages ILLEGAL_PATTERN

ILLEGAL_MAC_ADDRESS

public static final Messages ILLEGAL_MAC_ADDRESS

ILLEGAL_UUID

public static final Messages ILLEGAL_UUID

ILLEGAL_PATH

public static final Messages ILLEGAL_PATH

DEFAULT_META_EXPLICIT_BOOLEAN_OPTION_HANDLER

public static final Messages DEFAULT_META_EXPLICIT_BOOLEAN_OPTION_HANDLER

DEFAULT_META_FILE_OPTION_HANDLER

public static final Messages DEFAULT_META_FILE_OPTION_HANDLER

DEFAULT_META_INET_ADDRESS_OPTION_HANDLER

public static final Messages DEFAULT_META_INET_ADDRESS_OPTION_HANDLER

DEFAULT_META_MAC_ADDRESS_OPTION_HANDLER

public static final Messages DEFAULT_META_MAC_ADDRESS_OPTION_HANDLER

DEFAULT_META_PATH_OPTION_HANDLER

public static final Messages DEFAULT_META_PATH_OPTION_HANDLER

DEFAULT_META_PATTERN_OPTION_HANDLER

public static final Messages DEFAULT_META_PATTERN_OPTION_HANDLER

DEFAULT_META_REST_OF_ARGUMENTS_HANDLER

public static final Messages DEFAULT_META_REST_OF_ARGUMENTS_HANDLER

DEFAULT_META_STRING_ARRAY_OPTION_HANDLER

public static final Messages DEFAULT_META_STRING_ARRAY_OPTION_HANDLER

DEFAULT_META_STRING_OPTION_HANDLER

public static final Messages DEFAULT_META_STRING_OPTION_HANDLER

DEFAULT_META_SUB_COMMAND_HANDLER

public static final Messages DEFAULT_META_SUB_COMMAND_HANDLER

DEFAULT_META_URI_OPTION_HANDLER

public static final Messages DEFAULT_META_URI_OPTION_HANDLER

DEFAULT_META_URL_OPTION_HANDLER

public static final Messages DEFAULT_META_URL_OPTION_HANDLER

DEFAULT_META_UUID_OPTION_HANDLER

public static final Messages DEFAULT_META_UUID_OPTION_HANDLER

Method Detail

values

public static Messages[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Messages c : Messages.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Messages valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

formatWithLocale

public String formatWithLocale(Locale locale,
                      Object... args)

Description copied from interface: Localizable

Format the implicitly given message by this object with the given locale.

Specified by:

formatWithLocale in interface Localizable

Parameters:

locale - the locale to use for formatting .

args - the arguments to use for formatting. See MessageFormat.format(java.lang.String, java.lang.Object...).

Returns:

the formatted string.

format

public String format(Object... args)

Description copied from interface: Localizable

Format the implicitly given message by this object with the default locale.

Specified by:

format in interface Localizable

Parameters:

args - the arguments to use for formatting. See MessageFormat.format(java.lang.String, java.lang.Object...).

Returns:

the formatted string.