org.joda.time.convert

Class ReadablePeriodConverter

java.lang.Object

org.joda.time.convert.AbstractConverter

org.joda.time.convert.ReadablePeriodConverter

All Implemented Interfaces:

Converter, PeriodConverter

class ReadablePeriodConverter
extends AbstractConverter
implements PeriodConverter

ReadablePeriodConverter extracts milliseconds and chronology from a ReadablePeriod.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static ReadablePeriodConverter	INSTANCE Singleton instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadablePeriodConverter() Restricted constructor.

Method Summary

Modifier and Type	Method and Description
PeriodType	getPeriodType(java.lang.Object object) Selects a suitable period type for the given object.
java.lang.Class<?>	getSupportedType() Returns ReadablePeriod class.
void	setInto(ReadWritablePeriod duration, java.lang.Object object, Chronology chrono) Extracts duration values from an object of this converter's type, and sets them into the given ReadWritablePeriod.

Methods inherited from class org.joda.time.convert.AbstractConverter

getChronology, getChronology, getInstantMillis, getPartialValues, getPartialValues, isReadableInterval, toString

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

static final ReadablePeriodConverter INSTANCE

Singleton instance.

Constructor Detail

ReadablePeriodConverter

protected ReadablePeriodConverter()

Restricted constructor.

Method Detail

setInto

public void setInto(ReadWritablePeriod duration,
                    java.lang.Object object,
                    Chronology chrono)

Extracts duration values from an object of this converter's type, and sets them into the given ReadWritablePeriod.

Specified by:

setInto in interface PeriodConverter

Parameters:

duration - duration to get modified

object - the object to convert, must not be null

chrono - the chronology to use

Throws:

java.lang.NullPointerException - if the duration or object is null

java.lang.ClassCastException - if the object is an invalid type

java.lang.IllegalArgumentException - if the object is invalid

getPeriodType

public PeriodType getPeriodType(java.lang.Object object)

Selects a suitable period type for the given object.

Specified by:

getPeriodType in interface PeriodConverter

Overrides:

getPeriodType in class AbstractConverter

Parameters:

object - the object to examine, must not be null

Returns:

the period type from the readable duration

Throws:

java.lang.NullPointerException - if the object is null

java.lang.ClassCastException - if the object is an invalid type

getSupportedType

public java.lang.Class<?> getSupportedType()

Returns ReadablePeriod class.

Specified by:

getSupportedType in interface Converter

Returns:

ReadablePeriod.class