com.garygregory.jcommander.converters.time

Class DurationConverter

java.lang.Object

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

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

com.garygregory.jcommander.converters.time.DurationConverter

All Implemented Interfaces:

com.beust.jcommander.IStringConverter<Duration>

public class DurationConverter
extends AbstractBaseConverter<Duration>

Converts a String into a Duration.

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

Example:

 @Parameter(names = { "--duration" }, converter = DurationConverter.class)
 private Duration duration;
 

Since:

1.0.0

Author:

Gary Gregory

See Also:

Duration, Duration.parse(CharSequence)

Field Summary

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

failOnNull, targetClass

Constructor Summary

Constructors

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

Method Summary

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

DurationConverter

public DurationConverter(String optionName)

Constructs a converter.

Parameters:

optionName - The option name, may be null.

Method Detail

convertImpl

protected Duration convertImpl(String value)

Description copied from class: AbstractBaseConverter

Converts a value.

Specified by:

convertImpl in class AbstractBaseConverter<Duration>

Parameters:

value - the value to convert

Returns:

the converted value