public interface

InstantConverter

implements Converter
org.joda.time.convert.InstantConverter
Known Indirect Subclasses

Class Overview

InstantConverter defines how an object is converted to milliseconds/chronology.

The two methods in this interface must be called in order, as the getInstantMillis method relies on the result of the getChronology method being passed in.

Summary

Public Methods
abstract Chronology getChronology(Object object, Chronology chrono)
Extracts the chronology from an object of this converter's type where the chronology may be specified.
abstract Chronology getChronology(Object object, DateTimeZone zone)
Extracts the chronology from an object of this converter's type where the time zone is specified.
abstract long getInstantMillis(Object object, Chronology chrono)
Extracts the millis from an object of this converter's type.
[Expand]
Inherited Methods
From interface org.joda.time.convert.Converter

Public Methods

public abstract Chronology getChronology (Object object, Chronology chrono)

Extracts the chronology from an object of this converter's type where the chronology may be specified.

If the chronology is non-null it should be used. If it is null, then the object should be queried, and if it has no chronology then ISO default is used.

Parameters
object the object to convert
chrono the chronology to use, null means use object
Returns
  • the chronology, never null
Throws
ClassCastException if the object is invalid

public abstract Chronology getChronology (Object object, DateTimeZone zone)

Extracts the chronology from an object of this converter's type where the time zone is specified.

Parameters
object the object to convert
zone the specified zone to use, null means default zone
Returns
  • the chronology, never null
Throws
ClassCastException if the object is invalid

public abstract long getInstantMillis (Object object, Chronology chrono)

Extracts the millis from an object of this converter's type.

The chronology passed in is the result of the call to getChronology.

Parameters
object the object to convert
chrono the chronology to use, which is the non-null result of getChronology()
Returns
  • the millisecond instant
Throws
ClassCastException if the object is invalid
IllegalArgumentException if object conversion fails