com.garygregory.jcommander.converters.time

Class PeriodConverter

java.lang.Object

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

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

com.garygregory.jcommander.converters.time.PeriodConverter

All Implemented Interfaces:

com.beust.jcommander.IStringConverter<Period>

public class PeriodConverter
extends AbstractBaseConverter<Period>

Converts a String into a Period.

For a description of the format, see Period.parse(CharSequence).

Example:

 @Parameter(names = { "--period" }, converter = PeriodConverter.class)
 private Period period;
 

Since:

1.0.0

Author:

Gary Gregory

See Also:

Period, Period.parse(CharSequence)

Field Summary

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

failOnNull, targetClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Period	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

PeriodConverter

public PeriodConverter(String optionName)

Constructs a converter.

Parameters:

optionName - The option name, may be null.

Method Detail

convertImpl

protected Period convertImpl(String value)

Description copied from class: AbstractBaseConverter

Converts a value.

Specified by:

convertImpl in class AbstractBaseConverter<Period>

Parameters:

value - the value to convert

Returns:

the converted value