org.kohsuke.args4j

pack-priv final Enum Messages

Class Inheritance

extends Enum<Messages>
implements Localizable

java.lang.Object
java.lang.Enum
org.kohsuke.args4j.Messages

All Implemented Interfaces

org.kohsuke.args4j.Localizable

Imports

java.text.MessageFormat, java.util.Locale, .ResourceBundle

Author: Kohsuke Kawaguchi

Field Summary

Modifier and Type	Field and Description
public static final Messages	DEFAULT_VALUE
public static final Messages	FORBIDDEN_OPTION_PRESENT
public static final Messages	METADATA_ERROR
public static final Messages	MISSING_OPERAND
public static final Messages	MULTIPLE_USE_OF_ARGUMENT
public static final Messages	MULTIPLE_USE_OF_OPTION
public static final Messages	NO_ARGUMENT_ALLOWED
public static final Messages	NO_CONSTRUCTOR_ON_HANDLER
public static final Messages	NO_OPTIONHANDLER
public static final Messages	NO_SUCH_FILE
public static final Messages	REQUIRED_ARGUMENT_MISSING
public static final Messages	REQUIRED_OPTION_MISSING
public static final Messages	REQUIRES_OPTION_MISSING
public static final Messages	TOO_MANY_ARGUMENTS
public static final Messages	UNDEFINED_OPTION
public static final Messages	UNKNOWN_HANDLER

Constructor Summary

Access	Constructor and Description
private	Messages()

Method Summary

Modifier and Type	Method and Description
public String	format(Object... the arguments to use for formatting. See `MessageFormat#format(java.lang.String, java.lang.Object...)`. args) Implements org.kohsuke.args4j.Localizable.format. Format the implicitly given message by `this` object with the default locale.
public String	formatWithLocale(Locale the locale to use for formatting . locale, Object... the arguments to use for formatting. See `MessageFormat#format(java.lang.String, java.lang.Object...)`. args) Implements org.kohsuke.args4j.Localizable.formatWithLocale. Format the implicitly given message by `this` object with the given locale.
public static Messages	valueOf(String name)
public static Messages[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DEFAULT_VALUE	back to summary
public static final Messages DEFAULT_VALUE

FORBIDDEN_OPTION_PRESENT	back to summary
public static final Messages FORBIDDEN_OPTION_PRESENT

METADATA_ERROR	back to summary
public static final Messages METADATA_ERROR

MISSING_OPERAND	back to summary
public static final Messages MISSING_OPERAND

MULTIPLE_USE_OF_ARGUMENT	back to summary
public static final Messages MULTIPLE_USE_OF_ARGUMENT

MULTIPLE_USE_OF_OPTION	back to summary
public static final Messages MULTIPLE_USE_OF_OPTION

NO_ARGUMENT_ALLOWED	back to summary
public static final Messages NO_ARGUMENT_ALLOWED

NO_CONSTRUCTOR_ON_HANDLER	back to summary
public static final Messages NO_CONSTRUCTOR_ON_HANDLER

NO_OPTIONHANDLER	back to summary
public static final Messages NO_OPTIONHANDLER

NO_SUCH_FILE	back to summary
public static final Messages NO_SUCH_FILE

REQUIRED_ARGUMENT_MISSING	back to summary
public static final Messages REQUIRED_ARGUMENT_MISSING

REQUIRED_OPTION_MISSING	back to summary
public static final Messages REQUIRED_OPTION_MISSING

REQUIRES_OPTION_MISSING	back to summary
public static final Messages REQUIRES_OPTION_MISSING

TOO_MANY_ARGUMENTS	back to summary
public static final Messages TOO_MANY_ARGUMENTS

UNDEFINED_OPTION	back to summary
public static final Messages UNDEFINED_OPTION

UNKNOWN_HANDLER	back to summary
public static final Messages UNKNOWN_HANDLER

Constructor Detail

Messages	back to summary
private Messages()

Method Detail

format back to summary

format	back to summary
public String format(Object... args) Implements org.kohsuke.args4j.Localizable.format. Doc from org.kohsuke.args4j.Localizable.format. Format the implicitly given message by `this` object with the default locale. Parameters args:Object[] the arguments to use for formatting. See `MessageFormat#format(java.lang.String, java.lang.Object...)`. Returns:String the formatted string.

public String format(Object... args)

Implements org.kohsuke.args4j.Localizable.format.

Doc from org.kohsuke.args4j.Localizable.format.

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

Parameters

args:Object[]: the arguments to use for formatting. See MessageFormat#format(java.lang.String, java.lang.Object...).

Returns:String

the formatted string.

formatWithLocale back to summary

formatWithLocale	back to summary
public String formatWithLocale(Locale locale, Object... args) Implements org.kohsuke.args4j.Localizable.formatWithLocale. Doc from org.kohsuke.args4j.Localizable.formatWithLocale. Format the implicitly given message by `this` object with the given locale. Parameters locale:Locale the locale to use for formatting . args:Object[] the arguments to use for formatting. See `MessageFormat#format(java.lang.String, java.lang.Object...)`. Returns:String the formatted string.

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

Implements org.kohsuke.args4j.Localizable.formatWithLocale.

Doc from org.kohsuke.args4j.Localizable.formatWithLocale.

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

Parameters

locale:Locale: the locale to use for formatting .
args:Object[]: the arguments to use for formatting. See MessageFormat#format(java.lang.String, java.lang.Object...).

Returns:String

the formatted string.

valueOf	back to summary
public static Messages valueOf(String name)

values	back to summary
public static Messages[] values()