net.sf.mmm.util.cli

Interface NlsBundleUtilCliRoot

All Superinterfaces:

NlsBundle

public interface NlsBundleUtilCliRoot
extends NlsBundle

This interface holds the internationalized messages for this module.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	INF_MAIN_MODE_DEFAULT
static String	INF_MAIN_MODE_HELP
static String	INF_MAIN_MODE_VERSION
static String	MSG_BUNDLE_CONVERTER_USAGE
static String	MSG_BUNDLE_CONVERTER_USAGE_ARGUMENT
static String	MSG_BUNDLE_CONVERTER_USAGE_EVAL_CHOICE
static String	MSG_BUNDLE_CONVERTER_USAGE_FORMAT
static String	MSG_BUNDLE_CONVERTER_USAGE_KEY_PATTERN
static String	MSG_BUNDLE_CONVERTER_USAGE_MODE_DEFAULT
static String	MSG_BUNDLE_CONVERTER_USAGE_PATH_EXPRESSION
static String	MSG_MAIN_MODE_HELP_USAGE
static String	MSG_MAIN_MODE_VERSION_USAGE
static String	MSG_MAIN_OPTION_HELP_USAGE
static String	MSG_MAIN_OPTION_VERSION_USAGE
static String	MSG_SYNCHRONIZER_USAGE
static String	MSG_SYNCHRONIZER_USAGE_BUNDLE_CLASS
static String	MSG_SYNCHRONIZER_USAGE_DATE_PATTERN
static String	MSG_SYNCHRONIZER_USAGE_ENCODING
static String	MSG_SYNCHRONIZER_USAGE_LOCALES
static String	MSG_SYNCHRONIZER_USAGE_MODE_DEFAULT
static String	MSG_SYNCHRONIZER_USAGE_PATH

Fields inherited from interface net.sf.mmm.util.nls.api.NlsBundle

INTERFACE_NAME_SUFFIX

Method Summary

Modifier and Type	Method and Description
NlsMessage	errorCliArgumentMissing(String argument, String mode)
NlsMessage	errorCliArgumentReferenceMissing(Object reference, Object argument)
NlsMessage	errorCliClassNoProperty(Object type)
NlsMessage	errorCliModeUndefined(String mode, Object value)
NlsMessage	errorCliOptionAndArgumentAnnotation(String property)
NlsMessage	errorCliOptionDuplicate(String option)
NlsMessage	errorCliOptionIncompatibleModes(Object option1, Object option2)
NlsMessage	errorCliOptionMisplaced(String option)
NlsMessage	errorCliOptionMissing(String option, String mode)
NlsMessage	errorCliOptionMissingValue(String option)
NlsMessage	errorCliOptionNameIllegal(Object option, Object name)
NlsMessage	errorCliOptionUndefined(String option)
NlsMessage	errorCliParameterListEmpty()
NlsMessage	errorCliParser(Object type)
NlsMessage	infoMainModeDefault()
NlsMessage	infoMainModeHelp()
NlsMessage	infoMainModeVersion()
NlsMessage	messageBundleConverterUsage()
NlsMessage	messageBundleConverterUsageArgument(Object operand, Object defaultValue)
NlsMessage	messageBundleConverterUsageEvalChoice(Object operand, Object defaultValue)
NlsMessage	messageBundleConverterUsageFormat(Object operand, Object defaultValue)
NlsMessage	messageBundleConverterUsageKeyPattern(Object operand, Object defaultValue)
NlsMessage	messageBundleConverterUsageModeDefault(Object mainClass)
NlsMessage	messageBundleConverterUsagePathExpression(Object operand, Object defaultValue)
NlsMessage	messageCliAdditionalOptions()
NlsMessage	messageCliArguments()
NlsMessage	messageCliModeUsage(Object mode)
NlsMessage	messageCliOptionValues()
NlsMessage	messageCliRequiredOptions()
NlsMessage	messageCliUsage(Object mainClass, Object option)
NlsMessage	messageMainModeHelpUsage()
NlsMessage	messageMainModeVersionUsage()
NlsMessage	messageMainOptionHelpUsage()
NlsMessage	messageMainOptionVersionUsage()
NlsMessage	messageSynchronizerUsage()
NlsMessage	messageSynchronizerUsageBundleClass()
NlsMessage	messageSynchronizerUsageDatePattern(Object operand, Object defaultValue)
NlsMessage	messageSynchronizerUsageEncoding(Object operand, Object defaultValue)
NlsMessage	messageSynchronizerUsageLocales()
NlsMessage	messageSynchronizerUsageModeDefault(Object mainClass)
NlsMessage	messageSynchronizerUsagePath(Object operand, Object defaultValue)

Field Detail

INF_MAIN_MODE_HELP

static final String INF_MAIN_MODE_HELP

See Also:

AbstractMain, Constant Field Values

INF_MAIN_MODE_VERSION

static final String INF_MAIN_MODE_VERSION

See Also:

AbstractMain, Constant Field Values

INF_MAIN_MODE_DEFAULT

static final String INF_MAIN_MODE_DEFAULT

See Also:

AbstractMain, Constant Field Values

MSG_MAIN_OPTION_HELP_USAGE

static final String MSG_MAIN_OPTION_HELP_USAGE

See Also:

AbstractMain, Constant Field Values

MSG_MAIN_MODE_HELP_USAGE

static final String MSG_MAIN_MODE_HELP_USAGE

See Also:

AbstractMain, Constant Field Values

MSG_MAIN_OPTION_VERSION_USAGE

static final String MSG_MAIN_OPTION_VERSION_USAGE

See Also:

AbstractVersionedMain, Constant Field Values

MSG_MAIN_MODE_VERSION_USAGE

static final String MSG_MAIN_MODE_VERSION_USAGE

See Also:

AbstractMain, Constant Field Values

MSG_SYNCHRONIZER_USAGE

static final String MSG_SYNCHRONIZER_USAGE

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_SYNCHRONIZER_USAGE_MODE_DEFAULT

static final String MSG_SYNCHRONIZER_USAGE_MODE_DEFAULT

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE

static final String MSG_BUNDLE_CONVERTER_USAGE

See Also:

ResourceBundleConverter, Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_MODE_DEFAULT

static final String MSG_BUNDLE_CONVERTER_USAGE_MODE_DEFAULT

See Also:

ResourceBundleConverter, Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_KEY_PATTERN

static final String MSG_BUNDLE_CONVERTER_USAGE_KEY_PATTERN

See Also:

messageBundleConverterUsageKeyPattern(Object, Object), Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_FORMAT

static final String MSG_BUNDLE_CONVERTER_USAGE_FORMAT

See Also:

messageBundleConverterUsageFormat(Object, Object), Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_PATH_EXPRESSION

static final String MSG_BUNDLE_CONVERTER_USAGE_PATH_EXPRESSION

See Also:

messageBundleConverterUsagePathExpression(Object, Object), Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_ARGUMENT

static final String MSG_BUNDLE_CONVERTER_USAGE_ARGUMENT

See Also:

messageBundleConverterUsageArgument(Object, Object), Constant Field Values

MSG_BUNDLE_CONVERTER_USAGE_EVAL_CHOICE

static final String MSG_BUNDLE_CONVERTER_USAGE_EVAL_CHOICE

See Also:

messageBundleConverterUsageEvalChoice(Object, Object), Constant Field Values

MSG_SYNCHRONIZER_USAGE_LOCALES

static final String MSG_SYNCHRONIZER_USAGE_LOCALES

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_SYNCHRONIZER_USAGE_ENCODING

static final String MSG_SYNCHRONIZER_USAGE_ENCODING

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_SYNCHRONIZER_USAGE_PATH

static final String MSG_SYNCHRONIZER_USAGE_PATH

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_SYNCHRONIZER_USAGE_DATE_PATTERN

static final String MSG_SYNCHRONIZER_USAGE_DATE_PATTERN

See Also:

ResourceBundleSynchronizer, Constant Field Values

MSG_SYNCHRONIZER_USAGE_BUNDLE_CLASS

static final String MSG_SYNCHRONIZER_USAGE_BUNDLE_CLASS

See Also:

ResourceBundleSynchronizer, Constant Field Values

Method Detail

infoMainModeHelp

NlsMessage infoMainModeHelp()

Returns:

the NlsMessage

See Also:

AbstractMain

infoMainModeVersion

NlsMessage infoMainModeVersion()

Returns:

the NlsMessage

See Also:

AbstractMain

infoMainModeDefault

NlsMessage infoMainModeDefault()

Returns:

the NlsMessage

See Also:

AbstractMain

messageMainOptionHelpUsage

NlsMessage messageMainOptionHelpUsage()

Returns:

the NlsMessage

See Also:

AbstractMain

messageMainModeHelpUsage

NlsMessage messageMainModeHelpUsage()

Returns:

the NlsMessage

See Also:

AbstractMain

messageMainOptionVersionUsage

NlsMessage messageMainOptionVersionUsage()

Returns:

the NlsMessage

See Also:

AbstractVersionedMain

messageMainModeVersionUsage

NlsMessage messageMainModeVersionUsage()

Returns:

the NlsMessage

See Also:

AbstractMain

messageSynchronizerUsage

NlsMessage messageSynchronizerUsage()

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsageModeDefault

NlsMessage messageSynchronizerUsageModeDefault(@Named(value="mainClass")
                                               Object mainClass)

Parameters:

mainClass - is the Class with the main-method.

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsageLocales

NlsMessage messageSynchronizerUsageLocales()

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsageEncoding

NlsMessage messageSynchronizerUsageEncoding(@Named(value="operand")
                                            Object operand,
                                            @Named(value="defaultValue")
                                            Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsagePath

NlsMessage messageSynchronizerUsagePath(@Named(value="operand")
                                        Object operand,
                                        @Named(value="defaultValue")
                                        Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsageDatePattern

NlsMessage messageSynchronizerUsageDatePattern(@Named(value="operand")
                                               Object operand,
                                               @Named(value="defaultValue")
                                               Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageSynchronizerUsageBundleClass

NlsMessage messageSynchronizerUsageBundleClass()

Returns:

the NlsMessage

See Also:

ResourceBundleSynchronizer

messageCliUsage

NlsMessage messageCliUsage(@Named(value="mainClass")
                           Object mainClass,
                           @Named(value="option")
                           Object option)

Parameters:

mainClass - the qualified name of the CLI Class (with the main method).

option - the CliOption.

Returns:

the NlsMessage

See Also:

AbstractCliParser

messageCliModeUsage

NlsMessage messageCliModeUsage(@Named(value="mode")
                               Object mode)

Parameters:

mode - the CliMode.

Returns:

the NlsMessage

See Also:

AbstractCliParser

messageCliRequiredOptions

NlsMessage messageCliRequiredOptions()

Returns:

the NlsMessage

See Also:

AbstractCliParser

messageCliAdditionalOptions

NlsMessage messageCliAdditionalOptions()

Returns:

the NlsMessage

See Also:

AbstractCliParser

messageCliOptionValues

NlsMessage messageCliOptionValues()

Returns:

the NlsMessage

messageCliArguments

NlsMessage messageCliArguments()

Returns:

the NlsMessage

See Also:

AbstractCliParser

errorCliOptionDuplicate

NlsMessage errorCliOptionDuplicate(@Named(value="option")
                                   String option)

Parameters:

option - is the duplicated option.

Returns:

the NlsMessage

See Also:

CliOptionDuplicateException

errorCliOptionUndefined

NlsMessage errorCliOptionUndefined(@Named(value="option")
                                   String option)

Parameters:

option - is the undefined option.

Returns:

the NlsMessage

See Also:

CliOptionUndefinedException

errorCliOptionMissingValue

NlsMessage errorCliOptionMissingValue(@Named(value="option")
                                      String option)

Parameters:

option - is the option with missing value.

Returns:

the NlsMessage

See Also:

CliOptionMissingValueException

errorCliOptionMissing

NlsMessage errorCliOptionMissing(@Named(value="option")
                                 String option,
                                 @Named(value="mode")
                                 String mode)

Parameters:

option - is the missing but required option.

mode - is the current mode.

Returns:

the NlsMessage

See Also:

CliOptionMissingException

errorCliArgumentMissing

NlsMessage errorCliArgumentMissing(@Named(value="argument")
                                   String argument,
                                   @Named(value="mode")
                                   String mode)

Parameters:

argument - is the missing but required argument.

mode - is the current mode.

Returns:

the NlsMessage

See Also:

CliArgumentMissingException

errorCliArgumentReferenceMissing

NlsMessage errorCliArgumentReferenceMissing(@Named(value="reference")
                                            Object reference,
                                            @Named(value="argument")
                                            Object argument)

Parameters:

reference - is the missing reference.

argument - is the argument containing the reference.

Returns:

the NlsMessage

See Also:

CliArgumentReferenceMissingException

errorCliOptionMisplaced

NlsMessage errorCliOptionMisplaced(@Named(value="option")
                                   String option)

Parameters:

option - is the misplaced option.

Returns:

the NlsMessage

See Also:

CliOptionMisplacedException

errorCliOptionAndArgumentAnnotation

NlsMessage errorCliOptionAndArgumentAnnotation(@Named(value="property")
                                               String property)

Parameters:

property - is the name of the annotated property.

Returns:

the NlsMessage

See Also:

CliOptionAndArgumentAnnotationException

errorCliParameterListEmpty

NlsMessage errorCliParameterListEmpty()

Returns:

the NlsMessage

See Also:

CliParameterListEmptyException

errorCliClassNoProperty

NlsMessage errorCliClassNoProperty(@Named(value="type")
                                   Object type)

Parameters:

type - is the CLI Class.

Returns:

the NlsMessage

See Also:

CliClassNoPropertyException

errorCliModeUndefined

NlsMessage errorCliModeUndefined(@Named(value="mode")
                                 String mode,
                                 @Named(value="value")
                                 Object value)

Parameters:

mode - is the undefined mode.

value - is the referencing object.

Returns:

the NlsMessage

See Also:

CliModeUndefinedException

errorCliOptionNameIllegal

NlsMessage errorCliOptionNameIllegal(@Named(value="option")
                                     Object option,
                                     @Named(value="name")
                                     Object name)

Parameters:

option - is the actual option.

name - is the illegal name or alias.

Returns:

the NlsMessage

See Also:

CliOptionIllegalNameOrAliasException

errorCliOptionIncompatibleModes

NlsMessage errorCliOptionIncompatibleModes(@Named(value="option1")
                                           Object option1,
                                           @Named(value="option2")
                                           Object option2)

Parameters:

option1 - is the first incompatible option.

option2 - is the second incompatible option.

Returns:

the NlsMessage

See Also:

CliOptionIncompatibleModesException

errorCliParser

NlsMessage errorCliParser(@Named(value="type")
                          Object type)

Parameters:

type - is the type of the invalid state.

Returns:

the NlsMessage

See Also:

CliParserExcepiton

messageBundleConverterUsage

NlsMessage messageBundleConverterUsage()

Returns:

the NlsMessage

See Also:

ResourceBundleConverter

messageBundleConverterUsageModeDefault

NlsMessage messageBundleConverterUsageModeDefault(@Named(value="mainClass")
                                                  Object mainClass)

Parameters:

mainClass - is the Class with the main-method.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter

messageBundleConverterUsageKeyPattern

NlsMessage messageBundleConverterUsageKeyPattern(@Named(value="operand")
                                                 Object operand,
                                                 @Named(value="defaultValue")
                                                 Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter.getKeyPattern()

messageBundleConverterUsageFormat

NlsMessage messageBundleConverterUsageFormat(@Named(value="operand")
                                             Object operand,
                                             @Named(value="defaultValue")
                                             Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter.getFormat()

messageBundleConverterUsagePathExpression

NlsMessage messageBundleConverterUsagePathExpression(@Named(value="operand")
                                                     Object operand,
                                                     @Named(value="defaultValue")
                                                     Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter.getPathExpression()

messageBundleConverterUsageArgument

NlsMessage messageBundleConverterUsageArgument(@Named(value="operand")
                                               Object operand,
                                               @Named(value="defaultValue")
                                               Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter.getArgument()

messageBundleConverterUsageEvalChoice

NlsMessage messageBundleConverterUsageEvalChoice(@Named(value="operand")
                                                 Object operand,
                                                 @Named(value="defaultValue")
                                                 Object defaultValue)

Parameters:

operand - is the operand is the name of the operand for this option.

defaultValue - is the default value for this option.

Returns:

the NlsMessage

See Also:

ResourceBundleConverter.getEvalChoice()