Class BritishCutoverDate

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<java.time.chrono.ChronoLocalDate>, java.time.chrono.ChronoLocalDate, java.time.temporal.Temporal, java.time.temporal.TemporalAccessor, java.time.temporal.TemporalAdjuster

    public final class BritishCutoverDate
    extends java.lang.Object
    implements java.time.chrono.ChronoLocalDate, java.io.Serializable
    A date in the British Cutover calendar system.

    This date operates using the British Cutover calendar.

    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:
    Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.time.chrono.ChronoLocalDateTime<BritishCutoverDate> atTime​(java.time.LocalTime localTime)  
      boolean equals​(java.lang.Object obj)
      Compares this date to another date, including the chronology.
      static BritishCutoverDate from​(java.time.temporal.TemporalAccessor temporal)
      Obtains a BritishCutoverDate from a temporal object.
      BritishCutoverChronology getChronology()
      Gets the chronology of this date, which is the British Cutover calendar system.
      JulianEra getEra()
      Gets the era applicable at this date.
      long getLong​(java.time.temporal.TemporalField field)  
      int hashCode()
      A hash code for this date.
      int lengthOfMonth()
      Returns the length of the month represented by this date.
      int lengthOfYear()
      Returns the length of the year represented by this date.
      BritishCutoverDate minus​(long amountToSubtract, java.time.temporal.TemporalUnit unit)  
      BritishCutoverDate minus​(java.time.temporal.TemporalAmount amount)  
      static BritishCutoverDate now()
      Obtains the current BritishCutoverDate from the system clock in the default time-zone.
      static BritishCutoverDate now​(java.time.Clock clock)
      Obtains the current BritishCutoverDate from the specified clock.
      static BritishCutoverDate now​(java.time.ZoneId zone)
      Obtains the current BritishCutoverDate from the system clock in the specified time-zone.
      static BritishCutoverDate of​(int prolepticYear, int month, int dayOfMonth)
      Obtains a BritishCutoverDate representing a date in the British Cutover calendar system from the proleptic-year, month-of-year and day-of-month fields.
      BritishCutoverDate plus​(long amountToAdd, java.time.temporal.TemporalUnit unit)  
      BritishCutoverDate plus​(java.time.temporal.TemporalAmount amount)  
      <R> R query​(java.time.temporal.TemporalQuery<R> query)  
      java.time.temporal.ValueRange range​(java.time.temporal.TemporalField field)  
      java.time.temporal.ValueRange rangeChrono​(java.time.temporal.ChronoField field)  
      long toEpochDay()  
      java.lang.String toString()  
      java.time.chrono.ChronoPeriod until​(java.time.chrono.ChronoLocalDate endDateExclusive)  
      long until​(java.time.temporal.Temporal endExclusive, java.time.temporal.TemporalUnit unit)  
      BritishCutoverDate with​(java.time.temporal.TemporalAdjuster adjuster)  
      BritishCutoverDate with​(java.time.temporal.TemporalField field, long newValue)  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.time.chrono.ChronoLocalDate

        adjustInto, compareTo, format, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, toString
      • Methods inherited from interface java.time.temporal.TemporalAccessor

        get, getLong, range
    • Method Detail

      • now

        public static BritishCutoverDate now()
        Obtains the current BritishCutoverDate 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 BritishCutoverDate now​(java.time.ZoneId zone)
        Obtains the current BritishCutoverDate 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 BritishCutoverDate now​(java.time.Clock clock)
        Obtains the current BritishCutoverDate 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:
        java.time.DateTimeException - if the current date cannot be obtained
      • of

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

        This returns a BritishCutoverDate with the specified fields.

        Dates in the middle of the cutover gap, such as the 10th September 1752, will not throw an exception. Instead, the date will be treated as a Julian date and converted to an ISO date, with the day of month shifted by 11 days.

        Invalid dates, such as September 31st will throw an exception.

        Parameters:
        prolepticYear - the British Cutover proleptic-year
        month - the British Cutover month-of-year, from 1 to 12
        dayOfMonth - the British Cutover day-of-month, from 1 to 31
        Returns:
        the date in British Cutover calendar system, not null
        Throws:
        java.time.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 BritishCutoverDate from​(java.time.temporal.TemporalAccessor temporal)
        Obtains a BritishCutoverDate from a temporal object.

        This obtains a date in the British Cutover 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 BritishCutoverDate.

        The conversion 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, BritishCutoverDate::from.

        Parameters:
        temporal - the temporal object to convert, not null
        Returns:
        the date in British Cutover calendar system, not null
        Throws:
        java.time.DateTimeException - if unable to convert to a BritishCutoverDate
      • rangeChrono

        public java.time.temporal.ValueRange rangeChrono​(java.time.temporal.ChronoField field)
      • getChronology

        public BritishCutoverChronology getChronology()
        Gets the chronology of this date, which is the British Cutover 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 java.time.chrono.ChronoLocalDate
        Returns:
        the British Cutover chronology, not null
      • getEra

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

        The British Cutover calendar system has two eras, 'AD' and 'BC', defined by JulianEra.

        Specified by:
        getEra in interface java.time.chrono.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. This takes into account the cutover, returning 19 in September 1752.

        Specified by:
        lengthOfMonth in interface java.time.chrono.ChronoLocalDate
        Returns:
        the length of the month in days, from 19 to 31
      • lengthOfYear

        public int lengthOfYear()
        Returns the length of the year represented by this date.

        This returns the length of the year in days. This takes into account the cutover, returning 355 in 1752.

        Specified by:
        lengthOfYear in interface java.time.chrono.ChronoLocalDate
        Returns:
        the length of the month in days, from 19 to 31
      • with

        public BritishCutoverDate with​(java.time.temporal.TemporalAdjuster adjuster)
        Specified by:
        with in interface java.time.chrono.ChronoLocalDate
        Specified by:
        with in interface java.time.temporal.Temporal
      • with

        public BritishCutoverDate with​(java.time.temporal.TemporalField field,
                                       long newValue)
        Specified by:
        with in interface java.time.chrono.ChronoLocalDate
        Specified by:
        with in interface java.time.temporal.Temporal
      • plus

        public BritishCutoverDate plus​(java.time.temporal.TemporalAmount amount)
        Specified by:
        plus in interface java.time.chrono.ChronoLocalDate
        Specified by:
        plus in interface java.time.temporal.Temporal
      • plus

        public BritishCutoverDate plus​(long amountToAdd,
                                       java.time.temporal.TemporalUnit unit)
        Specified by:
        plus in interface java.time.chrono.ChronoLocalDate
        Specified by:
        plus in interface java.time.temporal.Temporal
      • minus

        public BritishCutoverDate minus​(java.time.temporal.TemporalAmount amount)
        Specified by:
        minus in interface java.time.chrono.ChronoLocalDate
        Specified by:
        minus in interface java.time.temporal.Temporal
      • minus

        public BritishCutoverDate minus​(long amountToSubtract,
                                        java.time.temporal.TemporalUnit unit)
        Specified by:
        minus in interface java.time.chrono.ChronoLocalDate
        Specified by:
        minus in interface java.time.temporal.Temporal
      • atTime

        public java.time.chrono.ChronoLocalDateTime<BritishCutoverDate> atTime​(java.time.LocalTime localTime)
        Specified by:
        atTime in interface java.time.chrono.ChronoLocalDate
      • until

        public long until​(java.time.temporal.Temporal endExclusive,
                          java.time.temporal.TemporalUnit unit)
        Specified by:
        until in interface java.time.chrono.ChronoLocalDate
        Specified by:
        until in interface java.time.temporal.Temporal
      • until

        public java.time.chrono.ChronoPeriod until​(java.time.chrono.ChronoLocalDate endDateExclusive)
        Specified by:
        until in interface java.time.chrono.ChronoLocalDate
      • toEpochDay

        public long toEpochDay()
        Specified by:
        toEpochDay in interface java.time.chrono.ChronoLocalDate
      • query

        public <R> R query​(java.time.temporal.TemporalQuery<R> query)
        Specified by:
        query in interface java.time.chrono.ChronoLocalDate
        Specified by:
        query in interface java.time.temporal.TemporalAccessor
      • equals

        public boolean equals​(java.lang.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 java.time.chrono.ChronoLocalDate
        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 java.time.chrono.ChronoLocalDate
        Returns:
        a suitable hash code based only on the Chronology and the date
      • range

        public java.time.temporal.ValueRange range​(java.time.temporal.TemporalField field)
        Specified by:
        range in interface java.time.temporal.TemporalAccessor
      • getLong

        public long getLong​(java.time.temporal.TemporalField field)
        Specified by:
        getLong in interface java.time.temporal.TemporalAccessor
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.time.chrono.ChronoLocalDate
        Overrides:
        toString in class java.lang.Object