org.threeten.bp.chrono.MinguoEra.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  * Neither the name of JSR-310 nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.threeten.bp.chrono

import org.threeten.bp.DateTimeException

object MinguoEra {

  /**
   * The singleton instance for the era BEFORE_ROC, 'Before Republic of China'. This has the numeric
   * value of {@code 0}.
   */
  lazy val BEFORE_ROC = new MinguoEra("BEFORE_ROC", 0)

  /**
   * The singleton instance for the era ROC, 'Republic of China'. This has the numeric value of
   * {@code 1}.
   */
  lazy val ROC = new MinguoEra("ROC", 1)

  lazy val values: Array[MinguoEra] = Array(BEFORE_ROC, ROC)

  /**
   * Obtains an instance of {@code MinguoEra} from an {@code int} value.
   *
   * {@code MinguoEra} is an enum representing the Minguo eras of BEFORE_ROC/ROC. This factory
   * allows the enum to be obtained from the {@code int} value.
   *
   * @param era
   *   the BEFORE_ROC/ROC value to represent, from 0 (BEFORE_ROC) to 1 (ROC)
   * @return
   *   the era singleton, not null
   * @throws DateTimeException
   *   if the value is invalid
   */
  def of(era: Int): MinguoEra =
    era match {
      case 0 => BEFORE_ROC
      case 1 => ROC
      case _ => throw new DateTimeException(s"Invalid era: $era")
    }

}

/**
 * An era in the Minguo calendar system.
 *
 * The Minguo calendar system has two eras. The date {@code 0001-01-01 (Minguo)} is equal to {@code
 * 1912-01-01 (ISO)}.
 *
 * Do not use {@code ordinal()} to obtain the numeric representation of {@code MinguoEra}. Use
 * {@code getValue()} instead.
 *
 * Specification for implementors This is an immutable and thread-safe enum.
 */
final class MinguoEra(name: String, ordinal: Int) extends Enum[MinguoEra](name, ordinal) with Era {

  /**
   * Gets the numeric era {@code int} value.
   *
   * The era BEFORE_ROC has the value 0, while the era ROC has the value 1.
   *
   * @return
   *   the era value, from 0 (BEFORE_ROC) to 1 (ROC)
   */
  def getValue: Int = ordinal

}