Class DiscordianDate

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

    This date operates using the Discordian calendar. This calendar system is used by some adherents to Discordianism. The Discordian differs from the Gregorian in terms of the length of the week and month, and uses an offset year. Dates are aligned such that 0001-01-01 (Discordian) is -1165-01-01 (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<DiscordianDate> atTime​(java.time.LocalTime localTime)  
      boolean equals​(java.lang.Object obj)
      Compares this date to another date, including the chronology.
      static DiscordianDate from​(java.time.temporal.TemporalAccessor temporal)
      Obtains a DiscordianDate from a temporal object.
      DiscordianChronology getChronology()
      Gets the chronology of this date, which is the Discordian calendar system.
      DiscordianEra 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()  
      DiscordianDate minus​(long amountToSubtract, java.time.temporal.TemporalUnit unit)  
      DiscordianDate minus​(java.time.temporal.TemporalAmount amount)  
      static DiscordianDate now()
      Obtains the current DiscordianDate from the system clock in the default time-zone.
      static DiscordianDate now​(java.time.Clock clock)
      Obtains the current DiscordianDate from the specified clock.
      static DiscordianDate now​(java.time.ZoneId zone)
      Obtains the current DiscordianDate from the system clock in the specified time-zone.
      static DiscordianDate of​(int prolepticYear, int month, int dayOfMonth)
      Obtains a DiscordianDate representing a date in the Discordian calendar system from the proleptic-year, month-of-year and day-of-month fields.
      DiscordianDate plus​(long amountToAdd, java.time.temporal.TemporalUnit unit)  
      DiscordianDate 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)  
      DiscordianDate with​(java.time.temporal.TemporalAdjuster adjuster)  
      DiscordianDate 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, equals, format, hashCode, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, lengthOfYear, query
      • Methods inherited from interface java.time.temporal.TemporalAccessor

        get
    • Method Detail

      • now

        public static DiscordianDate now()
        Obtains the current DiscordianDate 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 DiscordianDate now​(java.time.ZoneId zone)
        Obtains the current DiscordianDate 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 DiscordianDate now​(java.time.Clock clock)
        Obtains the current DiscordianDate 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 DiscordianDate of​(int prolepticYear,
                                        int month,
                                        int dayOfMonth)
        Obtains a DiscordianDate representing a date in the Discordian calendar system from the proleptic-year, month-of-year and day-of-month fields.

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

        St. Tib's Day is indicated by specifying 0 for both month and day-of-month.

        Parameters:
        prolepticYear - the Discordian proleptic-year
        month - the Discordian month-of-year, from 1 to 5
        dayOfMonth - the Discordian day-of-month, from 1 to 73
        Returns:
        the date in Discordian 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 DiscordianDate from​(java.time.temporal.TemporalAccessor temporal)
        Obtains a DiscordianDate from a temporal object.

        This obtains a date in the Discordian 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 DiscordianDate.

        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, DiscordianDate::from.

        Parameters:
        temporal - the temporal object to convert, not null
        Returns:
        the date in Discordian calendar system, not null
        Throws:
        java.time.DateTimeException - if unable to convert to a DiscordianDate
      • 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
      • getChronology

        public DiscordianChronology getChronology()
        Gets the chronology of this date, which is the Discordian 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 Discordian chronology, not null
      • getEra

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

        The Discordian calendar system has one era, 'YOLD', defined by DiscordianEra.

        Specified by:
        getEra in interface java.time.chrono.ChronoLocalDate
        Returns:
        the era YOLD, not null
      • lengthOfMonth

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

        public DiscordianDate 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 DiscordianDate 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 DiscordianDate 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 DiscordianDate 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 DiscordianDate 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 DiscordianDate 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<DiscordianDate> 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
      • toString

        public java.lang.String toString()
        Specified by:
        toString 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
        Overrides:
        equals in class java.lang.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 java.time.chrono.ChronoLocalDate
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a suitable hash code based only on the Chronology and the date