public final Class PaxChronology

Overrides default java.time.chrono.Chronology.date.

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

Parameters

era:Era

the Pax era, not null

yearOfEra:int

the year-of-era

month:int

the month-of-year

dayOfMonth:int

the day-of-month

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

ClassCastException:

if the era is not a PaxEra

Implements java.time.chrono.Chronology.date.

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

Parameters

prolepticYear:int

the proleptic-year

month:int

the month-of-year

dayOfMonth:int

the day-of-month

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Implements java.time.chrono.Chronology.date.

Obtains a Pax local date from another date-time object.

Parameters

temporal:TemporalAccessor

the date-time object to convert, not null

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Implements java.time.chrono.Chronology.dateEpochDay.

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

Parameters

epochDay:long

the epoch day

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Pax 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.

Returns:PaxDate

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

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Pax 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.

Parameters

zone:ZoneId

the ZoneId to use, not null

Returns:PaxDate

the current Pax local date using the system clock, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Pax 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.

Parameters

clock:Clock

the clock to use, not null

Returns:PaxDate

the current Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Overrides default java.time.chrono.Chronology.dateYearDay.

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

Parameters

era:Era

the Pax era, not null

yearOfEra:int

the year-of-era

dayOfYear:int

the day-of-year

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

ClassCastException:

if the era is not a PaxEra

Implements java.time.chrono.Chronology.dateYearDay.

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

Parameters

prolepticYear:int

the proleptic-year

dayOfYear:int

the day-of-year

Returns:PaxDate

the Pax local date, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to create the date

Implements java.time.chrono.Chronology.eraOf.

Doc from java.time.chrono.Chronology.eraOf.

Creates the chronology era object from the numeric value.

The era is, conceptually, the largest division of the time-line. Most calendar systems have a single epoch dividing the time-line into two eras. However, some have multiple eras, such as one for the reign of each leader. The exact meaning is determined by the chronology according to the following constraints.

The era in use at 1970-01-01 must have the value 1. Later eras must have sequentially higher values. Earlier eras must have sequentially lower values. Each chronology must refer to an enum or similar singleton to provide the era values.

This method returns the singleton era of the correct type for the specified era value.

Parameters

eraValue:int

the era value

Returns:PaxEra

the calendar system era, not null

Annotations

@Override

Implements java.time.chrono.Chronology.eras.

Doc from java.time.chrono.Chronology.eras.

Gets the list of eras for the chronology.

Most calendar systems have an era, within which the year has meaning. If the calendar system does not support the concept of eras, an empty list must be returned.

Returns:List<Era>

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

Annotations

@Override

Implements java.time.chrono.Chronology.getCalendarType.

Gets the calendar type of the underlying calendar system - 'pax'.

The Unicode Locale Data Markup Language (LDML) specification does not define an identifier for the Pax calendar, but were it to do so, 'pax' is highly likely to be chosen.

Returns:String

the calendar system type - 'pax'

Annotations

@Override

See Also

getId()

Implements java.time.chrono.Chronology.getId.

Gets the ID of the chronology - 'Pax'.

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

Returns:String

the chronology ID - 'Pax'

Annotations

@Override

See Also

getCalendarType()

Implements java.time.chrono.Chronology.isLeapYear.

Checks if the specified year is a leap year.

In general, a year is a leap year if the last two digits are divisible by 6 without remainder, or are 99. Years with the last two digits of 00 are also leap years, with the exception of years divisible by 400, which are not.

For example, 2012 is a leap year because the last two digits (12) are divisible by 6. 1999 is a leap year as the last two digits are both 9's (99). 1900 is a leap year as the last two digits are both 0's (00), however 2000 was not a leap year as it is divisible by 400. The year 0 is not a leap year.

Parameters

prolepticYear:long

the proleptic-year to check, not validated for range

Returns:boolean

true if the year is a leap year

Annotations

@Override

Overrides default java.time.chrono.Chronology.localDateTime.

Obtains a Pax local date-time from another date-time object.

Parameters

temporal:TemporalAccessor

the date-time object to convert, not null

Returns:ChronoLocalDateTime<PaxDate>

the Pax local date-time, not null

Annotations

@Override

@SuppressWarnings:unchecked

Exceptions

DateTimeException:

if unable to create the date-time

Implements java.time.chrono.Chronology.prolepticYear.

Doc from java.time.chrono.Chronology.prolepticYear.

Calculates the proleptic-year given the era and year-of-era.

This combines the era and year-of-era into the single proleptic-year field.

If the chronology makes active use of eras, such as JapaneseChronology then the year-of-era will be validated against the era. For other chronologies, validation is optional.

Parameters

era:Era

the era of the correct type for the chronology, not null

yearOfEra:int

the chronology year-of-era

Returns:int

the proleptic-year

Annotations

@Override

Implements java.time.chrono.Chronology.range.

Doc from java.time.chrono.Chronology.range.

Gets the range of valid values for the specified field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value.

Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

This method will return a result whether or not the chronology supports the field.

Parameters

field:ChronoField

the field to get the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Overrides java.time.chrono.AbstractChronology.resolveDate.

Implements java.time.chrono.Chronology.resolveDate.

Doc from java.time.chrono.AbstractChronology.resolveDate.

Resolves parsed ChronoField values into a date during parsing.

Most TemporalField implementations are resolved using the resolve method on the field. By contrast, the ChronoField class defines fields that only have meaning relative to the chronology. As such, ChronoField date fields are resolved here in the context of a specific chronology.

ChronoField instances are resolved by this method, which may be overridden in subclasses.

• EPOCH_DAY - If present, this is converted to a date and all other date fields are then cross-checked against the date.
• PROLEPTIC_MONTH - If present, then it is split into the YEAR and MONTH_OF_YEAR. If the mode is strict or smart then the field is validated.
• YEAR_OF_ERA and ERA - If both are present, then they are combined to form a YEAR. In lenient mode, the YEAR_OF_ERA range is not validated, in smart and strict mode it is. The ERA is validated for range in all three modes. If only the YEAR_OF_ERA is present, and the mode is smart or lenient, then the last available era is assumed. In strict mode, no era is assumed and the YEAR_OF_ERA is left untouched. If only the ERA is present, then it is left untouched.
• YEAR, MONTH_OF_YEAR and DAY_OF_MONTH - If all three are present, then they are combined to form a date. In all three modes, the YEAR is validated. If the mode is smart or strict, then the month and day are validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the first month in the requested year, then adding the difference in months, then the difference in days. If the mode is smart, and the day-of-month is greater than the maximum for the year-month, then the day-of-month is adjusted to the last day-of-month. If the mode is strict, then the three fields must form a valid date.
• YEAR and DAY_OF_YEAR - If both are present, then they are combined to form a date. In all three modes, the YEAR is validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the requested year, then adding the difference in days. If the mode is smart or strict, then the two fields must form a valid date.
• YEAR, MONTH_OF_YEAR, ALIGNED_WEEK_OF_MONTH and ALIGNED_DAY_OF_WEEK_IN_MONTH - If all four are present, then they are combined to form a date. In all three modes, the YEAR is validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the first month in the requested year, then adding the difference in months, then the difference in weeks, then in days. If the mode is smart or strict, then the all four fields are validated to their outer ranges. The date is then combined in a manner equivalent to creating a date on the first day of the requested year and month, then adding the amount in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the month.
• YEAR, MONTH_OF_YEAR, ALIGNED_WEEK_OF_MONTH and DAY_OF_WEEK - If all four are present, then they are combined to form a date. The approach is the same as described above for years, months and weeks in ALIGNED_DAY_OF_WEEK_IN_MONTH. The day-of-week is adjusted as the next or same matching day-of-week once the years, months and weeks have been handled.
• YEAR, ALIGNED_WEEK_OF_YEAR and ALIGNED_DAY_OF_WEEK_IN_YEAR - If all three are present, then they are combined to form a date. In all three modes, the YEAR is validated. If the mode is lenient, then the date is combined in a manner equivalent to creating a date on the first day of the requested year, then adding the difference in weeks, then in days. If the mode is smart or strict, then the all three fields are validated to their outer ranges. The date is then combined in a manner equivalent to creating a date on the first day of the requested year, then adding the amount in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the year.
• YEAR, ALIGNED_WEEK_OF_YEAR and DAY_OF_WEEK - If all three are present, then they are combined to form a date. The approach is the same as described above for years and weeks in ALIGNED_DAY_OF_WEEK_IN_YEAR. The day-of-week is adjusted as the next or same matching day-of-week once the years and weeks have been handled.

The default implementation is suitable for most calendar systems. If java.time.temporal.ChronoField#YEAR_OF_ERA is found without an java.time.temporal.ChronoField#ERA then the last era in eras() is used. The implementation assumes a 7 day week, that the first day-of-month has the value 1, that first day-of-year has the value 1, and that the first of the month and year always exists.

Parameters

fieldValues:Map<TemporalField, Long>

the map of fields to values, which can be updated, not null

resolverStyle:ResolverStyle

the requested type of resolve, not null

Returns:PaxDate

the resolved date, null if insufficient information to create a date

Annotations

@Override

Overrides default java.time.chrono.Chronology.zonedDateTime.

Obtains a Pax zoned date-time from another date-time object.

Parameters

temporal:TemporalAccessor

the date-time object to convert, not null

Returns:ChronoZonedDateTime<PaxDate>

the Pax zoned date-time, not null

Annotations

@Override

@SuppressWarnings:unchecked

Exceptions

DateTimeException:

if unable to create the date-time

Overrides default java.time.chrono.Chronology.zonedDateTime.

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

Parameters

instant:Instant

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

zone:ZoneId

the time-zone, not null

Returns:ChronoZonedDateTime<PaxDate>

the Pax zoned date-time, not null

Annotations

@Override

@SuppressWarnings:unchecked

Exceptions

DateTimeException:

if the result exceeds the supported range