Module org.threeten.extra

Package org.threeten.extra.chrono

Class InternationalFixedChronology

java.lang.Object

java.time.chrono.AbstractChronology

org.threeten.extra.chrono.InternationalFixedChronology

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.time.chrono.Chronology>, java.time.chrono.Chronology

public final class InternationalFixedChronology
extends java.time.chrono.AbstractChronology
implements java.io.Serializable

The International Fixed calendar system.

This chronology defines the rules of the International Fixed calendar system. It shares the leap year rule with the Gregorian calendar. Dates are aligned such that 0001-01-01 (International Fixed) is 0001-01-01 (ISO).

This class is proleptic. It implements only years greater or equal to 1.

This class implements a calendar where January 1st is the start of the year.

The fields are defined as follows:

• era - There is only one era, the current 'Common Era' (CE).
• year-of-era - The year-of-era for the current era increases uniformly from the epoch at year 1.
• proleptic-year - The proleptic year is the same as the year-of-era for the current era.
• month-of-year - There are 13 months in an International Fixed year, numbered from 1 to 13.
• day-of-month - There are 28 days in a standard International Fixed month, numbered from 1 to 28, with day 29 used in months 6 and 12 (month 6 only has 29 days in a leap year).
• day-of-year - There are 365 days in a standard International Fixed year and 366 days in a leap year. The days are numbered accordingly.
• leap-year - Leap years occur every 4 years, but skips 3 out of four centuries, i.e. when the century is not divisible by 400. This is the same rule in use for the Gregorian calendar.
• Week day - every month starts on a Sunday. Leap-day and year-day are neither part of a week, nor of any month.

Implementation Requirements

This class is immutable and thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static InternationalFixedChronology	INSTANCE	Singleton instance for the International fixed chronology.

Constructor Summary

Constructors

Constructor	Description
InternationalFixedChronology()	Deprecated. Use the singleton INSTANCE instead.

Method Summary

Modifier and Type	Method	Description
InternationalFixedDate	date(int prolepticYear, int month, int dayOfMonth)	Obtains a local date in International Fixed calendar system from the proleptic-year, month-of-year and day-of-month fields.
InternationalFixedDate	date(java.time.chrono.Era era, int yearOfEra, int month, int dayOfMonth)	Obtains a local date in International Fixed calendar system from the era, year-of-era, month-of-year and day-of-month fields.
InternationalFixedDate	date(java.time.temporal.TemporalAccessor temporal)	Obtains a International Fixed local date from another date-time object.
InternationalFixedDate	dateEpochDay(long epochDay)	Obtains a local date in the International Fixed calendar system from the epoch-day.
InternationalFixedDate	dateNow()	Obtains the current International Fixed local date from the system clock in the default time-zone.
InternationalFixedDate	dateNow(java.time.Clock clock)	Obtains the current International Fixed local date from the specified clock.
InternationalFixedDate	dateNow(java.time.ZoneId zone)	Obtains the current International Fixed local date from the system clock in the specified time-zone.
InternationalFixedDate	dateYearDay(int prolepticYear, int dayOfYear)	Obtains a local date in International Fixed calendar system from the proleptic-year and day-of-year fields.
InternationalFixedDate	dateYearDay(java.time.chrono.Era era, int yearOfEra, int dayOfYear)	Obtains a local date in International Fixed calendar system from the era, year-of-era and day-of-year fields.
InternationalFixedEra	eraOf(int eraValue)	Creates the chronology era object from the numeric value.
java.util.List<java.time.chrono.Era>	eras()	Gets the list of eras for the chronology.
java.lang.String	getCalendarType()	Gets the calendar type of the underlying calendar system, which returns null.
java.lang.String	getId()	Gets the ID of the chronology - 'Ifc'.
boolean	isLeapYear(long year)	Checks if the specified year is a leap year.
java.time.chrono.ChronoLocalDateTime<InternationalFixedDate>	localDateTime(java.time.temporal.TemporalAccessor temporal)	Obtains a International Fixed local date-time from another date-time object.
int	prolepticYear(java.time.chrono.Era era, int yearOfEra)
java.time.temporal.ValueRange	range(java.time.temporal.ChronoField field)
java.time.chrono.ChronoZonedDateTime<InternationalFixedDate>	zonedDateTime(java.time.Instant instant, java.time.ZoneId zone)	Obtains a International Fixed zoned date-time in this chronology from an Instant.
java.time.chrono.ChronoZonedDateTime<InternationalFixedDate>	zonedDateTime(java.time.temporal.TemporalAccessor temporal)	Obtains a International Fixed zoned date-time from another date-time object.

Methods inherited from class java.time.chrono.AbstractChronology

compareTo, equals, hashCode, resolveDate, toString

Methods inherited from interface java.time.chrono.Chronology

epochSecond, epochSecond, getDisplayName, period

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final InternationalFixedChronology INSTANCE

Singleton instance for the International fixed chronology.

Constructor Detail

InternationalFixedChronology

@Deprecated
public InternationalFixedChronology()

Deprecated.

Use the singleton INSTANCE instead.

Private constructor, that is public to satisfy the ServiceLoader.

Method Detail

getId

public java.lang.String getId()

Gets the ID of the chronology - 'Ifc'.

The ID uniquely identifies the Chronology. It can be used to lookup the Chronology using Chronology.of(String).

Specified by:

getId in interface java.time.chrono.Chronology

Returns:

the chronology ID - 'Ifc'

See Also:

getCalendarType()

getCalendarType

public java.lang.String getCalendarType()

Gets the calendar type of the underlying calendar system, which returns null.

The Unicode Locale Data Markup Language (LDML) specification does not define an identifier for this calendar system, thus null is returned.

Specified by:

getCalendarType in interface java.time.chrono.Chronology

Returns:

the calendar system type, null

See Also:

getId()

date

public InternationalFixedDate date(java.time.chrono.Era era,
                                   int yearOfEra,
                                   int month,
                                   int dayOfMonth)

Obtains a local date in International Fixed calendar system from the era, year-of-era, month-of-year and day-of-month fields.

Specified by:

date in interface java.time.chrono.Chronology

Parameters:

era - the International Fixed era, not null

yearOfEra - the year-of-era

month - the month-of-year

dayOfMonth - the day-of-month

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

java.lang.ClassCastException - if the era is not a InternationalFixedEra

date

public InternationalFixedDate date(int prolepticYear,
                                   int month,
                                   int dayOfMonth)

Obtains a local date in International Fixed calendar system from the proleptic-year, month-of-year and day-of-month fields.

Specified by:

date in interface java.time.chrono.Chronology

Parameters:

prolepticYear - the proleptic-year

month - the month-of-year

dayOfMonth - the day-of-month

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateYearDay

public InternationalFixedDate dateYearDay(java.time.chrono.Era era,
                                          int yearOfEra,
                                          int dayOfYear)

Obtains a local date in International Fixed calendar system from the era, year-of-era and day-of-year fields.

Specified by:

dateYearDay in interface java.time.chrono.Chronology

Parameters:

era - the International Fixed era, not null

yearOfEra - the year-of-era

dayOfYear - the day-of-year

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

java.lang.ClassCastException - if the era is not a InternationalFixedEra

dateYearDay

public InternationalFixedDate dateYearDay(int prolepticYear,
                                          int dayOfYear)

Obtains a local date in International Fixed calendar system from the proleptic-year and day-of-year fields.

Specified by:

dateYearDay in interface java.time.chrono.Chronology

Parameters:

prolepticYear - the proleptic-year

dayOfYear - the day-of-year

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateEpochDay

public InternationalFixedDate dateEpochDay(long epochDay)

Obtains a local date in the International Fixed calendar system from the epoch-day.

Specified by:

dateEpochDay in interface java.time.chrono.Chronology

Parameters:

epochDay - the epoch day

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public InternationalFixedDate dateNow()

Obtains the current International Fixed local date from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current date.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Specified by:

dateNow in interface java.time.chrono.Chronology

Returns:

the current International Fixed local date using the system clock and default time-zone, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public InternationalFixedDate dateNow(java.time.ZoneId zone)

Obtains the current International Fixed local date from the system clock in the specified time-zone.

This will query the system clock to obtain the current date. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Specified by:

dateNow in interface java.time.chrono.Chronology

Parameters:

zone - the zone ID to use, not null

Returns:

the current International Fixed local date using the system clock, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public InternationalFixedDate dateNow(java.time.Clock clock)

Obtains the current International Fixed local date from the specified clock.

This will query the specified clock to obtain the current date - today. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

Specified by:

dateNow in interface java.time.chrono.Chronology

Parameters:

clock - the clock to use, not null

Returns:

the current International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

date

public InternationalFixedDate date(java.time.temporal.TemporalAccessor temporal)

Obtains a International Fixed local date from another date-time object.

Specified by:

date in interface java.time.chrono.Chronology

Parameters:

temporal - the date-time object to convert, not null

Returns:

the International Fixed local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

localDateTime

public java.time.chrono.ChronoLocalDateTime<InternationalFixedDate> localDateTime(java.time.temporal.TemporalAccessor temporal)

Obtains a International Fixed local date-time from another date-time object.

Specified by:

localDateTime in interface java.time.chrono.Chronology

Parameters:

temporal - the date-time object to convert, not null

Returns:

the International Fixed local date-time, not null

Throws:

java.time.DateTimeException - if unable to create the date-time

zonedDateTime

public java.time.chrono.ChronoZonedDateTime<InternationalFixedDate> zonedDateTime(java.time.temporal.TemporalAccessor temporal)

Obtains a International Fixed zoned date-time from another date-time object.

Specified by:

zonedDateTime in interface java.time.chrono.Chronology

Parameters:

temporal - the date-time object to convert, not null

Returns:

the International Fixed zoned date-time, not null

Throws:

java.time.DateTimeException - if unable to create the date-time

zonedDateTime

public java.time.chrono.ChronoZonedDateTime<InternationalFixedDate> zonedDateTime(java.time.Instant instant,
                                                                                  java.time.ZoneId zone)

Obtains a International Fixed zoned date-time in this chronology from an Instant.

Specified by:

zonedDateTime in interface java.time.chrono.Chronology

Parameters:

instant - the instant to create the date-time from, not null

zone - the time-zone, not null

Returns:

the International Fixed zoned date-time, not null

Throws:

java.time.DateTimeException - if the result exceeds the supported range

isLeapYear

public boolean isLeapYear(long year)

Checks if the specified year is a leap year.

A leap-year is a year of a longer length than normal. Leap years in the calendar system match those of the ISO calendar system.

Specified by:

isLeapYear in interface java.time.chrono.Chronology

Parameters:

year - the proleptic-year to check, not validated for range

Returns:

true if the year is a leap year

eraOf

public InternationalFixedEra eraOf(int eraValue)

Creates the chronology era object from the numeric value.

Only one era is supported, CE, with the value 1.

Specified by:

eraOf in interface java.time.chrono.Chronology

Parameters:

eraValue - the era value

Returns:

the calendar system era, not null

Throws:

java.time.DateTimeException - if unable to create the era

eras

public java.util.List<java.time.chrono.Era> eras()

Gets the list of eras for the chronology.

Only one era is supported, CE, with the value 1.

Specified by:

eras in interface java.time.chrono.Chronology

Returns:

the list of eras for the chronology, may be immutable, not null

range

public java.time.temporal.ValueRange range(java.time.temporal.ChronoField field)

Specified by:

range in interface java.time.chrono.Chronology

prolepticYear

public int prolepticYear(java.time.chrono.Era era,
                         int yearOfEra)

Specified by:

prolepticYear in interface java.time.chrono.Chronology