de.esprit.common.clp

Class OptionLocale

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.common.clp.CommandLineOption<java.util.Locale>

de.esprit.common.clp.OptionLocale

All Implemented Interfaces:

Dumpable

public class OptionLocale
extends CommandLineOption<java.util.Locale>

This class defines the command line option -locale and returns a Locale option. The parsed locale is made the default system locale.

Author:

Rainer Buesch

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_NAME

Constructor Summary

Constructors

Constructor and Description
OptionLocale()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkValue() Performs additional checks on the entered option value (i.e. file existence etc..)
java.util.Locale	getValue() Returns the parsed value of this option.
void	parseValue(java.lang.String value) Parses and stores the given value from the command-line to this option.

Methods inherited from class de.esprit.common.clp.CommandLineOption

equals, getArgumentName, getDefaultValue, getEnvVariableName, getEnvVariableValue, getHelpText, getOption, getOptionAndArgument, getStringValue, hasArgument, hashCode, isMandatory, isPrintHelp, isPrintSyntax, isSecret, isValueTakenFromEnvVariable, parseDefaultValue, parseValue, setDefaultValue, setEnvVariableName, setFound, setHelpText, setMandatory, setPrintHelp, setPrintSyntax, setSecret, setStringValue, toDumpString, toString, wasFound

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OPTION_NAME

public static final java.lang.String OPTION_NAME

See Also:

Constant Field Values

Constructor Detail

OptionLocale

public OptionLocale()

Method Detail

getValue

public final java.util.Locale getValue()

Description copied from class: CommandLineOption

Returns the parsed value of this option.

Specified by:

getValue in class CommandLineOption<java.util.Locale>

parseValue

public void parseValue(java.lang.String value)
                throws java.lang.Exception

Description copied from class: CommandLineOption

Parses and stores the given value from the command-line to this option. Subclasses perform any type conversion if necessary.

Specified by:

parseValue in class CommandLineOption<java.util.Locale>

Throws:

java.lang.Exception

checkValue

public void checkValue()
                throws java.lang.Exception

Description copied from class: CommandLineOption

Performs additional checks on the entered option value (i.e. file existence etc..) If the option value is null but a defaultValue is defined then the latter is applied. The option may also check its dependencies of other options.

Overrides:

checkValue in class CommandLineOption<java.util.Locale>

Throws:

java.lang.Exception