Class Symmetry010Date

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

    This date operates using the Symmetry010 calendar. This calendar system is a proposed reform calendar system, and is not in common use. The Symmetry010 differs from the Gregorian in terms of month length, and the leap year rule. Dates are aligned such that 0001/01/01 (Sym010) is 0001-01-01 (ISO). The alignment of January 1st happens 40 times within a 293 years cycle, skipping 5, 6, 11 or 12 years in between: 1, 7, 18, 24, 29, 35, 46, 52, 57, 63, 74, 80, 85, 91, 103, 114, 120, 125, 131, 142, 148, 153, 159, 170, 176, 181, 187, 198, 210, 216, 221, 227, 238, 244, 249, 255, 266, 272, 277, 283.

    The implementation is a pure Symmetry010 calendar, as proposed by Dr. Irv Bromberg. The year shares the 12 months with the Gregorian calendar. The months February, May, August, November span 31 days, all other months consist of 30 days. In leap years, December is extended with a full week, the so-called "leap week". Thus December in a leap year has 37. Since each month is made of full weeks, the calendar is perennial, with every date fixed always on the same weekday. Each month starts on a Monday and ends on a Sunday; so does each year. The 13th day of a month is always a Saturday.

    More information is available on Wikipedia at Symmetry010 or on the calendar's home page.

    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<Symmetry010Date> atTime​(java.time.LocalTime localTime)  
      boolean equals​(java.lang.Object obj)
      Compares this date to another date, including the chronology.
      static Symmetry010Date from​(java.time.temporal.TemporalAccessor temporal)
      Obtains a Symmetry010Date from a temporal object.
      Symmetry010Chronology getChronology()
      Gets the chronology of this date, which is the Symmetry010 calendar system.
      java.time.chrono.IsoEra getEra()
      Gets the era applicable at this date.
      long getLong​(java.time.temporal.TemporalField field)  
      int hashCode()
      A hash code for this date.
      boolean isLeapWeek()
      Checks if the date is within the leap week.
      int lengthOfMonth()
      Returns the length of the month represented by this date.
      int lengthOfYear()
      Returns the length of the year represented by this date.
      Symmetry010Date minus​(long amountToSubtract, java.time.temporal.TemporalUnit unit)  
      Symmetry010Date minus​(java.time.temporal.TemporalAmount amount)  
      static Symmetry010Date now()
      Obtains the current Symmetry010Date from the system clock in the default time-zone.
      static Symmetry010Date now​(java.time.Clock clock)
      Obtains the current Symmetry010Date from the specified clock.
      static Symmetry010Date now​(java.time.ZoneId zone)
      Obtains the current Symmetry010Date from the system clock in the specified time-zone.
      static Symmetry010Date of​(int prolepticYear, int month, int dayOfMonth)
      Obtains a Symmetry010Date representing a date in the Symmetry010 calendar system from the proleptic-year, month-of-year and day-of-month fields.
      Symmetry010Date plus​(long amountToAdd, java.time.temporal.TemporalUnit unit)  
      Symmetry010Date plus​(java.time.temporal.TemporalAmount amount)  
      java.time.temporal.ValueRange range​(java.time.temporal.TemporalField field)  
      long toEpochDay()  
      java.lang.String toString()
      Display the date in human-readable format.
      java.time.chrono.ChronoPeriod until​(java.time.chrono.ChronoLocalDate endDateExclusive)  
      long until​(java.time.temporal.Temporal endExclusive, java.time.temporal.TemporalUnit unit)  
      Symmetry010Date with​(java.time.temporal.TemporalAdjuster adjuster)  
      Symmetry010Date 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, query
      • Methods inherited from interface java.time.temporal.TemporalAccessor

        get, getLong
    • Method Detail

      • now

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

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

        Parameters:
        prolepticYear - the Symmetry010 proleptic-year
        month - the Symmetry010 month-of-year, from 1 to 12
        dayOfMonth - the Symmetry010 day-of-month, from 1 to 30, or 1 to 31 in February, May, August, November, or 1 to 37 in December in a Leap Year
        Returns:
        the date in Symmetry010 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 Symmetry010Date from​(java.time.temporal.TemporalAccessor temporal)
        Obtains a Symmetry010Date from a temporal object.

        This obtains a date in the Symmetry010 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 Symmetry010Date.

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

        Parameters:
        temporal - the temporal object to convert, not null
        Returns:
        the date in the Symmetry010 calendar system, not null
        Throws:
        java.time.DateTimeException - if unable to convert to a Symmetry010Date
      • isLeapWeek

        public boolean isLeapWeek()
        Checks if the date is within the leap week.
        Returns:
        true if this date is in the leap week
      • range

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

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

        public java.time.chrono.IsoEra getEra()
        Gets the era applicable at this date.

        The Symmetry454 calendar system uses IsoEra.

        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. Month lengths do not match those of the ISO calendar system.

        Most months have 30 days, except for February, May, August, November each have 31 days. December in a leap year has 37 days.

        Specified by:
        lengthOfMonth in interface java.time.chrono.ChronoLocalDate
        Returns:
        the length of the month in days
      • lengthOfYear

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

        This returns the length of the year in days. Year lengths do NOT match those of the ISO calendar system.

        Specified by:
        lengthOfYear in interface java.time.chrono.ChronoLocalDate
        Returns:
        the length of the year in days: 364 or 371
      • with

        public Symmetry010Date 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 Symmetry010Date 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 Symmetry010Date 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 Symmetry010Date 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 Symmetry010Date 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 Symmetry010Date 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<Symmetry010Date> 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()
        Display the date in human-readable format.
        Specified by:
        toString in interface java.time.chrono.ChronoLocalDate
        Returns:
        the string representation
      • getLong

        public long getLong​(java.time.temporal.TemporalField field)
        Specified by:
        getLong 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
        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