com.github.joschi.jadconfig.jodatime.converters

Class PeriodConverter

java.lang.Object

com.github.joschi.jadconfig.jodatime.converters.PeriodConverter

All Implemented Interfaces:

Converter<org.joda.time.Period>

public class PeriodConverter
extends Object
implements Converter<org.joda.time.Period>

Allow periods to be passed in as number + unit or as a ISOPeriodFormat (standard, without millis).

Examples:

• 23s → Period.seconds(23)
• 30m → Period.minutes(30)
• 30h → Period.hours(30)
• 30d → Period.days(30)
• 2w → Period.weeks(2)
• 1y → Period.years(1)

See Also:

ISOPeriodFormat

Constructor Summary

Constructors

Constructor and Description
PeriodConverter()

Method Summary

Modifier and Type	Method and Description
org.joda.time.Period	convertFrom(String value) Returns a typed instance representing the specified String value.
String	convertTo(org.joda.time.Period value) Returns a String instance representing the configuration parameter's value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodConverter

public PeriodConverter()

Method Detail

convertFrom

public org.joda.time.Period convertFrom(String value)

Description copied from interface: Converter

Returns a typed instance representing the specified String value.

Specified by:

convertFrom in interface Converter<org.joda.time.Period>

Parameters:

value - The configuration parameter's String value

Returns:

A typed instance representing the configuration parameter's value

convertTo

public String convertTo(org.joda.time.Period value)

Description copied from interface: Converter

Returns a String instance representing the configuration parameter's value.

Specified by:

convertTo in interface Converter<org.joda.time.Period>

Parameters:

value - The configuration parameter's typed value

Returns:

A String instance representing the configuration parameter's typed value