MinguoEra (Java Platform SE 8 )
Keywords: java.time.chrono.MinguoEra class
Date: 2017-07-29

compact1, compact2, compact3
java.time.chrono

## Enum MinguoEra

- java.lang.Object
- - java.lang.Enum<MinguoEra>
  - - java.time.chrono.MinguoEra

- All Implemented Interfaces:
    Serializable, Comparable<MinguoEra>, 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.

  year-of-era | era | proleptic-year | ISO proleptic-year
  --- | --- | --- | ---
  2 | ROC | 2 | 1913
  1 | ROC | 1 | 1912
  1 | BEFORE_ROC | 0 | 1911
  2 | BEFORE_ROC | -1 | 1910

  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 Summary

    Enum Constants
    Enum Constant and Description
    `BEFORE_ROC` The singleton instance for the era before the current one, 'Before Republic of China Era', which has the numeric value 0.
    `ROC` The singleton instance for the current era, 'Republic of China Era', which has the numeric value 1.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getValue()` Gets the numeric era `int` value.
    `static MinguoEra` | `of(int minguoEra)` Obtains an instance of `MinguoEra` from an `int` value.
    `static MinguoEra` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static MinguoEra[]` | `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_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. This method may be used to iterate over the constants as follows:

          for (MinguoEra c : MinguoEra.values())
              System.out.println(c);

      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)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.