Module java.base

Enum IsoEra

  • All Implemented Interfaces:
    Serializable, Comparable<IsoEra>, Era, TemporalAccessor, TemporalAdjuster

    public enum IsoEra
    extends Enum<IsoEra>
    implements Era
    An era in the ISO calendar system.

    The ISO-8601 standard does not define eras. A definition has therefore been created with two eras - 'Current era' (CE) for years on or after 0001-01-01 (ISO), and 'Before current era' (BCE) for years before that.

    ISO years and eras
    year-of-era era proleptic-year

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

    Implementation Requirements:
    This is an immutable and thread-safe enum.
    • Enum Constant Detail

      • BCE

        public static final IsoEra BCE
        The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0.
      • CE

        public static final IsoEra CE
        The singleton instance for the current era, 'Current Era', which has the numeric value 1.
    • Method Detail

      • values

        public static IsoEra[] 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 (IsoEra c : IsoEra.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static IsoEra valueOf​(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.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • of

        public static IsoEra of​(int isoEra)
        Obtains an instance of IsoEra from an int value.

        IsoEra is an enum representing the ISO eras of BCE/CE. This factory allows the enum to be obtained from the int value.

        isoEra - the BCE/CE value to represent, from 0 (BCE) to 1 (CE)
        the era singleton, not null
        DateTimeException - if the value is invalid
      • getValue

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

        The era BCE has the value 0, while the era CE has the value 1.

        Specified by:
        getValue in interface Era
        the era value, from 0 (BCE) to 1 (CE)