net.time4j.history

Class HistoricDate

java.lang.Object

net.time4j.history.HistoricDate

All Implemented Interfaces:

java.lang.Comparable<HistoricDate>

public final class HistoricDate
extends java.lang.Object
implements java.lang.Comparable<HistoricDate>

Defines a historical date which consists of era, year of era, month and day of month.

The natural order is based on the timeline order.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
int	compareTo(HistoricDate other)
boolean	equals(java.lang.Object obj)
int	getDayOfMonth() Yields the historical day of month.
HistoricEra	getEra() Yields the historical era.
int	getMonth() Yields the historical month.
int	getYearOfEra() Yields year of the historical era.
int	hashCode()
static HistoricDate	of(HistoricEra era, int yearOfEra, int month, int dom) Constructs a new tuple of given historical chronological components.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static HistoricDate of(HistoricEra era,
                              int yearOfEra,
                              int month,
                              int dom)

Constructs a new tuple of given historical chronological components.

Note: A detailed validation is not done. Such a validation is the responsibility of any ChronoHistory, however.

Parameters:

era - historical era (AD or BC)

yearOfEra - year of related era (>= 1)

month - historical month (1-12)

dom - historical day of month (1-31)

Returns:

new historic date (not yet validated)

Throws:

java.lang.IllegalArgumentException - if any argument is out of required maximum range

Since:

3.0

See Also:

ChronoHistory.isValid(HistoricDate)

getEra

public HistoricEra getEra()

Yields the historical era.

Returns:

HistoricEra

Since:

3.0

getYearOfEra

public int getYearOfEra()

Yields year of the historical era.

Returns:

year of era (>= 1)

Since:

3.0

getMonth

public int getMonth()

Yields the historical month.

Returns:

month (1-12)

Since:

3.0

getDayOfMonth

public int getDayOfMonth()

Yields the historical day of month.

Returns:

day of month (1-31)

Since:

3.0

compareTo

public int compareTo(HistoricDate other)

Specified by:

compareTo in interface java.lang.Comparable<HistoricDate>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object