Package org.threeten.extra.chrono

Class PaxDate

java.lang.Object
org.threeten.extra.chrono.PaxDate
All Implemented Interfaces:
Serializable, Comparable<ChronoLocalDate>, ChronoLocalDate, Temporal, TemporalAccessor, TemporalAdjuster
public final class PaxDate extends Object implements ChronoLocalDate, Serializable
A date in the Pax calendar system.

This date operates using the Pax calendar. This calendar system is a proposed reform calendar system, and is not in common use. The Pax differs from the Gregorian in terms of month count and length, and the leap year rule. Dates are aligned such that 0001-01-01 (Pax) is 0000-12-31 (ISO).

More information is available in the Pax Calendar Wikipedia article.

Implementation Requirements

This class is immutable and thread-safe.

This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.

See Also:

  • Method Details

    • now

      public static PaxDate now()
      Obtains the current PaxDate 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:
      the current date using the system clock and default time-zone, not null

    • now

      public static PaxDate now(ZoneId zone)
      Obtains the current PaxDate 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 - the zone ID to use, not null
      Returns:
      the current date using the system clock, not null

    • now

      public static PaxDate now(Clock clock)
      Obtains the current PaxDate 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 - the clock to use, not null
      Returns:
      the current date, not null
      Throws:
      DateTimeException - if the current date cannot be obtained

    • of

      public static PaxDate of(int prolepticYear, int month, int dayOfMonth)
      Obtains a PaxDate representing a date in the Pax calendar system from the proleptic-year, month-of-year and day-of-month fields.

      This returns a PaxDate with the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.

      Parameters:
      prolepticYear - the Pax proleptic-year
      month - the Pax month-of-year, from 1 to 14
      dayOfMonth - the Pax day-of-month, from 1 to 28
      Returns:
      the date in Pax calendar system, not null
      Throws:
      DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-year

    • from

      public static PaxDate from(TemporalAccessor temporal)
      Obtains a PaxDate from a temporal object.

      This obtains a date in the Pax calendar system based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of PaxDate.

      The conversion typically uses the EPOCH_DAY field, which is standardized across calendar systems.

      This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, PaxDate::from.

      Parameters:
      temporal - the temporal object to convert, not null
      Returns:
      the date in the Pax calendar system, not null
      Throws:
      DateTimeException - if unable to convert to a PaxDate

    • range

      public ValueRange range(TemporalField field)
      Specified by:
      range in interface TemporalAccessor

    • getChronology

      public PaxChronology getChronology()
      Gets the chronology of this date, which is the Pax calendar system.

      The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.

      Specified by:
      getChronology in interface ChronoLocalDate
      Returns:
      the Pax chronology, not null

    • getEra

      public PaxEra getEra()
      Gets the era applicable at this date.

      The Pax calendar system has two eras, 'CE' and 'BCE', defined by PaxEra.

      Specified by:
      getEra in interface ChronoLocalDate
      Returns:
      the era applicable at this date, not null

    • lengthOfMonth

      public int lengthOfMonth()
      Returns the length of the month represented by this date.

      This returns the length of the month in days. Month lengths do not match those of the ISO calendar system.

      Specified by:
      lengthOfMonth in interface ChronoLocalDate
      Returns:
      the length of the month in days, from 7 to 28

    • lengthOfYear

      public int lengthOfYear()
      Specified by:
      lengthOfYear in interface ChronoLocalDate

    • with

      public PaxDate with(TemporalAdjuster adjuster)
      Specified by:
      with in interface ChronoLocalDate
      Specified by:
      with in interface Temporal

    • with

      public PaxDate with(TemporalField field, long newValue)
      Specified by:
      with in interface ChronoLocalDate
      Specified by:
      with in interface Temporal

    • plus

      public PaxDate plus(TemporalAmount amount)
      Specified by:
      plus in interface ChronoLocalDate
      Specified by:
      plus in interface Temporal

    • plus

      public PaxDate plus(long amountToAdd, TemporalUnit unit)
      Specified by:
      plus in interface ChronoLocalDate
      Specified by:
      plus in interface Temporal

    • minus

      public PaxDate minus(TemporalAmount amount)
      Specified by:
      minus in interface ChronoLocalDate
      Specified by:
      minus in interface Temporal

    • minus

      public PaxDate minus(long amountToSubtract, TemporalUnit unit)
      Specified by:
      minus in interface ChronoLocalDate
      Specified by:
      minus in interface Temporal

    • atTime

      public ChronoLocalDateTime<PaxDate> atTime(LocalTime localTime)
      Specified by:
      atTime in interface ChronoLocalDate

    • until

      public long until(Temporal endExclusive, TemporalUnit unit)
      Specified by:
      until in interface ChronoLocalDate
      Specified by:
      until in interface Temporal

    • until

      public ChronoPeriod until(ChronoLocalDate endDateExclusive)
      Specified by:
      until in interface ChronoLocalDate

    • toEpochDay

      public long toEpochDay()
      Specified by:
      toEpochDay in interface ChronoLocalDate

    • getLong

      public long getLong(TemporalField field)
      Specified by:
      getLong in interface TemporalAccessor

    • equals

      public boolean equals(Object obj)
      Compares this date to another date, including the chronology.

      Compares this date with another ensuring that the date is the same.

      Only objects of this concrete type are compared, other types return false. To compare the dates of two TemporalAccessor instances, including dates in two different chronologies, use ChronoField.EPOCH_DAY as a comparator.

      Specified by:
      equals in interface ChronoLocalDate
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to check, null returns false
      Returns:
      true if this is equal to the other date

    • hashCode

      public int hashCode()
      A hash code for this date.
      Specified by:
      hashCode in interface ChronoLocalDate
      Overrides:
      hashCode in class Object
      Returns:
      a suitable hash code based only on the Chronology and the date

    • toString

      public String toString()
      Specified by:
      toString in interface ChronoLocalDate
      Overrides:
      toString in class Object