Enum CopticEra

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

    public enum CopticEra
    extends java.lang.Enum<CopticEra>
    implements java.time.chrono.Era
    An era in the Coptic calendar system.

    The Coptic calendar system has two eras. The current era, for years from 1 onwards, is known as the 'Era of the Martyrs'. All previous years, zero or earlier in the proleptic count or one and greater in the year-of-era count, are part of the 'Before Era of the Martyrs' era.

    The start of the Coptic epoch 0001-01-01 (Coptic) is 0284-08-29 (ISO).

    Do not use ordinal() to obtain the numeric representation of CopticEra. Use getValue() instead.

    Implementation Requirements:

    This is an immutable and thread-safe enum.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AM
      The singleton instance for the current era, 'Era of the Martyrs', which has the numeric value 1.
      BEFORE_AM
      The singleton instance for the era before the current one, 'Before Era of the Martyrs', which has the numeric value 0.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Gets the numeric era int value.
      static CopticEra of​(int era)
      Obtains an instance of CopticEra from an int value.
      static CopticEra valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CopticEra[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.time.chrono.Era

        adjustInto, get, getDisplayName, getLong, isSupported, query, range
    • Enum Constant Detail

      • BEFORE_AM

        public static final CopticEra BEFORE_AM
        The singleton instance for the era before the current one, 'Before Era of the Martyrs', which has the numeric value 0.
      • AM

        public static final CopticEra AM
        The singleton instance for the current era, 'Era of the Martyrs', which has the numeric value 1.
    • Method Detail

      • values

        public static CopticEra[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CopticEra c : CopticEra.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CopticEra valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • of

        public static CopticEra of​(int era)
        Obtains an instance of CopticEra from an int value.

        CopticEra is an enum representing the Coptic eras of BEFORE_AM/AM. This factory allows the enum to be obtained from the int value.

        Parameters:
        era - the BEFORE_AM/AM value to represent, from 0 (BEFORE_AM) to 1 (AM)
        Returns:
        the era singleton, not null
        Throws:
        java.time.DateTimeException - if the value is invalid
      • getValue

        public int getValue()
        Gets the numeric era int value.

        The era BEFORE_AM has the value 0, while the era AM has the value 1.

        Specified by:
        getValue in interface java.time.chrono.Era
        Returns:
        the era value, from 0 (BEFORE_AM) to 1 (AM)