Module java.base

Enum ThaiBuddhistEra

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

    public enum ThaiBuddhistEra
    extends Enum<ThaiBuddhistEra>
    implements Era
    An era in the Thai Buddhist calendar system.

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

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

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

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

      • BEFORE_BE

        public static final ThaiBuddhistEra BEFORE_BE
        The singleton instance for the era before the current one, 'Before Buddhist Era', which has the numeric value 0.
      • BE

        public static final ThaiBuddhistEra BE
        The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.
    • Method Detail

      • values

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

        public static ThaiBuddhistEra 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 ThaiBuddhistEra of​(int thaiBuddhistEra)
        Obtains an instance of ThaiBuddhistEra from an int value.

        ThaiBuddhistEra is an enum representing the Thai Buddhist eras of BEFORE_BE/BE. This factory allows the enum to be obtained from the int value.

        thaiBuddhistEra - the era to represent, from 0 to 1
        the BuddhistEra singleton, never null
        DateTimeException - if the era is invalid
      • getValue

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

        The era BEFORE_BE has the value 0, while the era BE has the value 1.

        Specified by:
        getValue in interface Era
        the era value, from 0 (BEFORE_BE) to 1 (BE)
      • 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
        style - the style of the text required, not null
        locale - the locale to use, not null
        the text value of the era, not null