com.garygregory.jcommander.converters.util

Class LocaleConverter

java.lang.Object

com.beust.jcommander.converters.BaseConverter<T>

com.garygregory.jcommander.converters.AbstractBaseConverter<Locale>

com.garygregory.jcommander.converters.util.LocaleConverter

All Implemented Interfaces:

com.beust.jcommander.IStringConverter<Locale>

public class LocaleConverter
extends AbstractBaseConverter<Locale>

Converts a String into a Locale.

For a description of the format, see Locale and IETF BCP 47.

Example:

 @Parameter(names = { "--locale" }, converter = LocaleConverter.class)
 private Locale locale;
 

Since:

1.0.0

Author:

Gary Gregory

See Also:

Locale

Field Summary

Fields inherited from class com.garygregory.jcommander.converters.AbstractBaseConverter

failOnNull, targetClass

Constructor Summary

Constructors

Constructor and Description
LocaleConverter(String optionName) Constructs a converter.

Method Summary

Modifier and Type	Method and Description
protected Locale	convertImpl(String value) Converts a value.

Methods inherited from class com.garygregory.jcommander.converters.AbstractBaseConverter

convert, getErrorString, isSingle, newParameterException, newParameterException, split, toInt, toURI

Methods inherited from class com.beust.jcommander.converters.BaseConverter

getErrorString, getOptionName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocaleConverter

public LocaleConverter(String optionName)

Constructs a converter.

Parameters:

optionName - The option name, may be null.

Method Detail

convertImpl

protected Locale convertImpl(String value)

Description copied from class: AbstractBaseConverter

Converts a value.

Specified by:

convertImpl in class AbstractBaseConverter<Locale>

Parameters:

value - the value to convert

Returns:

the converted value