Module java.base
Package java.time.chrono

Enum MinguoEra

  • All Implemented Interfaces:
    Serializable, Comparable<MinguoEra>, Constable, Era, TemporalAccessor, TemporalAdjuster
    public enum MinguoEra
extends Enum<MinguoEra>
implements Era
    An era in the Minguo calendar system.

    The Minguo calendar system has two eras. The current era, for years from 1 onwards, is known as the 'Republic of China' era. 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 Republic of China' era.

    Minguo years and eras
    year-of-era era proleptic-year ISO proleptic-year
    2ROC21913
    1ROC11912
    1BEFORE_ROC01911
    2BEFORE_ROC-11910

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

    Implementation Requirements:
    This is an immutable and thread-safe enum.
    Since:
    1.8

    • Enum Constant Detail

      • BEFORE_ROC

        public static final MinguoEra BEFORE_ROC
        The singleton instance for the era before the current one, 'Before Republic of China Era', which has the numeric value 0.

      • ROC

        public static final MinguoEra ROC
        The singleton instance for the current era, 'Republic of China Era', which has the numeric value 1.

    • Method Detail

      • values

        public static MinguoEra[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MinguoEra 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.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • of

        public static MinguoEra of​(int minguoEra)
        Obtains an instance of MinguoEra from an int value.

        MinguoEra is an enum representing the Minguo eras of BEFORE_ROC/ROC. This factory allows the enum to be obtained from the int value.

        Parameters:
        minguoEra - the BEFORE_ROC/ROC value to represent, from 0 (BEFORE_ROC) to 1 (ROC)
        Returns:
        the era singleton, not null
        Throws:
        DateTimeException - if the value is invalid

      • getValue

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

        The era BEFORE_ROC has the value 0, while the era ROC has the value 1.

        Specified by:
        getValue in interface Era
        Returns:
        the era value, from 0 (BEFORE_ROC) to 1 (ROC)

      • getDisplayName

        public String getDisplayName​(TextStyle style,
                             Locale locale)
        Gets the textual representation of this era.

        This returns the textual name used to identify the era, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

        If no textual mapping is found then the numeric value is returned.

        Specified by:
        getDisplayName in interface Era
        Parameters:
        style - the style of the text required, not null
        locale - the locale to use, not null
        Returns:
        the text value of the era, not null