com.garygregory.jcommander.converters

Class AbstractBaseConverter<T>

java.lang.Object

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

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

Type Parameters:

T - the target type of the conversion.

All Implemented Interfaces:

com.beust.jcommander.IStringConverter<T>

Direct Known Subclasses:

AlgorithmParameterGeneratorConverter, AlgorithmParametersConverter, AllInetAddressesNameConverter, BigDecimalConverter, BigIntegerConverter, ByteOrderConverter, CertificateFactoryConverter, CertPathValidatorConverter, CharsetConverter, CipherConverter, ClassConverter, ConnectionConverter, CurrencyConverter, DateConverter, DriverConverter, DurationConverter, DurationConverter, ExemptionMechanismConverter, InetAddressNameConverter, InstantConverter, KeyAgreementConverter, KeyFactoryConverter, KeyGeneratorConverter, KeyManagerFactoryConverter, KeyPairGeneratorConverter, KeyStoreConverter, LocalDateConverter, LocalDateTimeConverter, LocaleConverter, LocalTimeConverter, MacConverter, MessageDigestConverter, MicrosoftTypesConverter, MonthDayConverter, MysqlTypesConverter, NetworkInterfaceIndexConverter, NetworkInterfaceNameConverter, OffsetDateTimeConverter, OffsetTimeConverter, OracleTypesConverter, PeriodConverter, PosixFilePermissionSetConverter, ProviderConverter, QNameConverter, SecretKeyFactoryConverter, SecureRandomConverter, SignatureConverter, TimeConverter, TimestampConverter, TimeZoneConverter, TrustManagerFactoryConverter, TypesConverter, URIConverter, URLConverter, UUIDConverter, YearConverter, YearMonthConverter, ZonedDateTimeConverter, ZoneIdConverter, ZoneOffsetConverter

public abstract class AbstractBaseConverter<T>
extends com.beust.jcommander.converters.BaseConverter<T>

Provides common services for converters in this package

Since:

1.0.0

Author:

Gary Gregory

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failOnNull Whether or not a null conversion failure throws a ParameterException.
protected Class<T>	targetClass The target class to convert strings.

Constructor Summary

Constructors

Constructor and Description
AbstractBaseConverter(String optionName, Class<T> targetClass) Constructs a new instance for the given option and target class.
AbstractBaseConverter(String optionName, Class<T> targetClass, boolean failOnNull) Constructs a new instance for the given option, target class and fail-on-null.

Method Summary

Modifier and Type	Method and Description
T	convert(String value) Converts the given value or throws a ParameterException.
protected abstract T	convertImpl(String value) Converts a value.
protected String	getErrorString(String value) Builds an error message for the given value in error
protected boolean	isSingle(String[] split) Returns true if the array is of size 1, false otherwise.
protected com.beust.jcommander.ParameterException	newParameterException(String value) Creates a new ParameterException for the given value.
protected com.beust.jcommander.ParameterException	newParameterException(String value, Throwable t) Creates a new ParameterException for the given value and throwable
protected String[]	split(String value) Splits the given string using ConverterConstants.VALUE_SEPARATOR as the boundary.
protected int	toInt(String optionName, String value) Converts the given value to an int for the given option.
protected URI	toURI(String optionName, String value) Converts the given string into a URI

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

Field Detail

targetClass

protected final Class<T> targetClass

The target class to convert strings.

failOnNull

protected final boolean failOnNull

Whether or not a null conversion failure throws a ParameterException.

Constructor Detail

AbstractBaseConverter

public AbstractBaseConverter(String optionName,
                             Class<T> targetClass)

Constructs a new instance for the given option and target class.

Parameters:

optionName - The option name, may be null.

targetClass - must not be null

AbstractBaseConverter

public AbstractBaseConverter(String optionName,
                             Class<T> targetClass,
                             boolean failOnNull)

Constructs a new instance for the given option, target class and fail-on-null.

Parameters:

optionName - may be null

targetClass - must not be null

failOnNull - if true, the converter fails when the conversion results in a null value

Method Detail

convert

public T convert(String value)

Converts the given value or throws a ParameterException. Delegates the actual conversion to subclasses with convertImpl(String).

Parameters:

value - the value to convert.

Throws:

com.beust.jcommander.ParameterException - for a conversion problem

convertImpl

protected abstract T convertImpl(String value)
                          throws Exception

Converts a value.

Parameters:

value - the value to convert

Returns:

the converted value

Throws:

Exception - subclasses can throw any Exception

getErrorString

protected String getErrorString(String value)

Builds an error message for the given value in error

Parameters:

value - the value that cause the error

Returns:

an error message

isSingle

protected boolean isSingle(String[] split)

Returns true if the array is of size 1, false otherwise.

Parameters:

split - an array

Returns:

true if the array is of size 1, false otherwise.

newParameterException

protected com.beust.jcommander.ParameterException newParameterException(String value)

Creates a new ParameterException for the given value.

Parameters:

value - the value in error

Returns:

a new ParameterException

newParameterException

protected com.beust.jcommander.ParameterException newParameterException(String value,
                                                                        Throwable t)

Creates a new ParameterException for the given value and throwable

Parameters:

value - the value in error

t - the throwable

Returns:

a new ParameterException

split

protected String[] split(String value)

Splits the given string using ConverterConstants.VALUE_SEPARATOR as the boundary.

Parameters:

value - the string to split

Returns:

the split array result

toInt

protected int toInt(String optionName,
                    String value)

Converts the given value to an int for the given option.

Parameters:

optionName - the option name

value - the value to parse

Returns:

the int result

toURI

protected URI toURI(String optionName,
                    String value)

Converts the given string into a URI

Parameters:

optionName - the option name

value - a string

Returns:

a new URI

See Also:

URI