Class AccountingDate

  • 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 AccountingDate
    extends java.lang.Object
    implements java.time.chrono.ChronoLocalDate, java.io.Serializable
    A date in an Accounting calendar system.

    This date operates using a given Accounting calendar. An Accounting calendar differs greatly from the ISO calendar. The start of the Accounting calendar will vary against the ISO calendar. Depending on options chosen, it can start as early as 0000-01-26 (ISO) or as late as 0001-01-04 (ISO).

    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<AccountingDate> atTime​(java.time.LocalTime localTime)  
      boolean equals​(java.lang.Object obj)
      Compares this date to another date, including the chronology.
      static AccountingDate from​(AccountingChronology chronology, java.time.temporal.TemporalAccessor temporal)
      Obtains an AccountingDate from a temporal object.
      AccountingChronology getChronology()
      Gets the chronology of this date, which is an Accounting calendar system.
      long getLong​(java.time.temporal.TemporalField field)  
      int hashCode()
      A hash code for this date.
      int lengthOfMonth()  
      int lengthOfYear()  
      AccountingDate minus​(long amountToSubtract, java.time.temporal.TemporalUnit unit)  
      AccountingDate minus​(java.time.temporal.TemporalAmount amount)  
      static AccountingDate now​(AccountingChronology chronology)
      Obtains the current AccountingDate from the system clock in the default time-zone, translated with the given AccountingChronology.
      static AccountingDate now​(AccountingChronology chronology, java.time.Clock clock)
      Obtains the current AccountingDate from the specified clock, translated with the given AccountingChronology.
      static AccountingDate now​(AccountingChronology chronology, java.time.ZoneId zone)
      Obtains the current AccountingDate from the system clock in the specified time-zone, translated with the given AccountingChronology.
      static AccountingDate of​(AccountingChronology chronology, int prolepticYear, int month, int dayOfMonth)
      Obtains a AccountingDate representing a date in the given accounting calendar system from the proleptic-year, month-of-year and day-of-month fields.
      AccountingDate plus​(long amountToAdd, java.time.temporal.TemporalUnit unit)  
      AccountingDate plus​(java.time.temporal.TemporalAmount amount)  
      java.time.temporal.ValueRange range​(java.time.temporal.TemporalField 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)  
      AccountingDate with​(java.time.temporal.TemporalAdjuster adjuster)  
      AccountingDate 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, getEra, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, query, toString
      • Methods inherited from interface java.time.temporal.TemporalAccessor

        get, getLong, range
    • Method Detail

      • now

        public static AccountingDate now​(AccountingChronology chronology)
        Obtains the current AccountingDate from the system clock in the default time-zone, translated with the given AccountingChronology.

        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.

        Parameters:
        chronology - the Accounting chronology to base the date on, not null
        Returns:
        the current date using the system clock and default time-zone, not null
        Throws:
        java.time.DateTimeException - if the current date cannot be obtained, NullPointerException if an AccountingChronology was not provided
      • now

        public static AccountingDate now​(AccountingChronology chronology,
                                         java.time.ZoneId zone)
        Obtains the current AccountingDate from the system clock in the specified time-zone, translated with the given AccountingChronology.

        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:
        chronology - the Accounting chronology to base the date on, not null
        zone - the zone ID to use, not null
        Returns:
        the current date using the system clock, not null
        Throws:
        java.time.DateTimeException - if the current date cannot be obtained, NullPointerException if an AccountingChronology was not provided
      • now

        public static AccountingDate now​(AccountingChronology chronology,
                                         java.time.Clock clock)
        Obtains the current AccountingDate from the specified clock, translated with the given AccountingChronology.

        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:
        chronology - the Accounting chronology to base the date on, not null
        clock - the clock to use, not null
        Returns:
        the current date, not null
        Throws:
        java.time.DateTimeException - if the current date cannot be obtained, NullPointerException if an AccountingChronology was not provided
      • of

        public static AccountingDate of​(AccountingChronology chronology,
                                        int prolepticYear,
                                        int month,
                                        int dayOfMonth)
        Obtains a AccountingDate representing a date in the given accounting calendar system from the proleptic-year, month-of-year and day-of-month fields.

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

        Parameters:
        chronology - the Accounting chronology to base the date on, not null
        prolepticYear - the Accounting proleptic-year
        month - the Accounting month-of-year, from 1 to 12 or 1 to 13
        dayOfMonth - the Accounting day-of-month, from 1 to 35 or 1 to 42
        Returns:
        the date in the given Accounting calendar system, not null
        Throws:
        java.time.DateTimeException - if the value of any field is out of range, if the day-of-month is invalid for the month-year, or if an AccountingChronology was not provided
      • from

        public static AccountingDate from​(AccountingChronology chronology,
                                          java.time.temporal.TemporalAccessor temporal)
        Obtains an AccountingDate from a temporal object.

        This obtains a date in the specified Accounting 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 AccountingDate.

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

        This method almost matches the signature of the functional interface TemporalQuery and must be used as a query via something that supplies the missing parameter, such as a curried method reference, temporal -> AccountingDate.from(chronology, temporal) (where chronology resolves to a set up AccountingChronology).

        Parameters:
        chronology - the Accounting chronology to base the date on, not null
        temporal - the temporal object to convert, not null
        Returns:
        the date in Accounting calendar system, not null
        Throws:
        java.time.DateTimeException - if unable to convert to an AccountingDate, NullPointerException if an AccountingChronology was not provided
      • getChronology

        public AccountingChronology getChronology()
        Gets the chronology of this date, which is an Accounting 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 Accounting chronology, not null
      • lengthOfMonth

        public int lengthOfMonth()
        Specified by:
        lengthOfMonth in interface java.time.chrono.ChronoLocalDate
      • lengthOfYear

        public int lengthOfYear()
        Specified by:
        lengthOfYear in interface java.time.chrono.ChronoLocalDate
      • with

        public AccountingDate 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 AccountingDate 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 AccountingDate 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 AccountingDate 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 AccountingDate 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 AccountingDate 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<AccountingDate> 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
      • 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