net.time4j.engine

Interface CalendarEra

public interface CalendarEra

Represents an era in a calendar system.

An era is date-related and defines a reference date which can be interpreted as start or end of an era. Not all calendar systems know an era concept, however. Especially all ISO-calendar systems have no era according to ISO-8601-standard. If an era exists in a given calendar system then the meaning of a year changes such that it means the year of an era counting as positive number from >= 1.

Author:

Meno Hochschild

Method Summary

Methods

Modifier and Type	Method and Description
GregorianDate	getDate() Yields the reference date (start or end of an era).
int	getValue() Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.
boolean	isStarting() Queries if the associated reference date defines the start of this era.
String	name() Yields the canonical non-localized name.

Method Detail

name

String name()

Yields the canonical non-localized name.

Returns:

String

getValue

int getValue()

Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.

Returns:

int

getDate

GregorianDate getDate()

Yields the reference date (start or end of an era).

Returns:

gregorian date

See Also:

isStarting()

isStarting

boolean isStarting()

Queries if the associated reference date defines the start of this era.

A system of eras is required to define at most one ending era and if so then only as first era. In such an ending era the year 1 is the last and not the first year of era!

Returns:

boolean

See Also:

getDate()