1 /*
2  * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 /*
27  * This file is available under and governed by the GNU General Public
28  * License version 2 only, as published by the Free Software Foundation.
29  * However, the following notice accompanied the original version of this
30  * file:
31  *
32  * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos
33  *
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions are met:
38  *
39  *  * Redistributions of source code must retain the above copyright notice,
40  *    this list of conditions and the following disclaimer.
41  *
42  *  * Redistributions in binary form must reproduce the above copyright notice,
43  *    this list of conditions and the following disclaimer in the documentation
44  *    and/or other materials provided with the distribution.
45  *
46  *  * Neither the name of JSR-310 nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
54  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  */
62 package java.time.chrono;
63 
64 import java.time.DateTimeException;
65 
66 /**
67  * An era in the Minguo calendar system.
68  * <p>
69  * The Minguo calendar system has two eras.
70  * The current era, for years from 1 onwards, is known as the 'Republic of China' era.
71  * All previous years, zero or earlier in the proleptic count or one and greater
72  * in the year-of-era count, are part of the 'Before Republic of China' era.
73  *
74  * <table summary="Minguo years and eras" cellpadding="2" cellspacing="3" border="0" >
75  * <thead>
76  * <tr class="tableSubHeadingColor">
77  * <th class="colFirst" align="left">year-of-era</th>
78  * <th class="colFirst" align="left">era</th>
79  * <th class="colFirst" align="left">proleptic-year</th>
80  * <th class="colLast" align="left">ISO proleptic-year</th>
81  * </tr>
82  * </thead>
83  * <tbody>
84  * <tr class="rowColor">
85  * <td>2</td><td>ROC</td><td>2</td><td>1913</td>
86  * </tr>
87  * <tr class="altColor">
88  * <td>1</td><td>ROC</td><td>1</td><td>1912</td>
89  * </tr>
90  * <tr class="rowColor">
91  * <td>1</td><td>BEFORE_ROC</td><td>0</td><td>1911</td>
92  * </tr>
93  * <tr class="altColor">
94  * <td>2</td><td>BEFORE_ROC</td><td>-1</td><td>1910</td>
95  * </tr>
96  * </tbody>
97  * </table>
98  * <p>
99  * <b>Do not use {@code ordinal()} to obtain the numeric representation of {@code MinguoEra}.
100  * Use {@code getValue()} instead.</b>
101  *
102  * @implSpec
103  * This is an immutable and thread-safe enum.
104  *
105  * @since 1.8
106  */
107 public enum MinguoEra implements Era {
108 
109     /**
110      * The singleton instance for the era before the current one, 'Before Republic of China Era',
111      * which has the numeric value 0.
112      */
113     BEFORE_ROC,
114     /**
115      * The singleton instance for the current era, 'Republic of China Era',
116      * which has the numeric value 1.
117      */
118     ROC;
119 
120     //-----------------------------------------------------------------------
121     /**
122      * Obtains an instance of {@code MinguoEra} from an {@code int} value.
123      * <p>
124      * {@code MinguoEra} is an enum representing the Minguo eras of BEFORE_ROC/ROC.
125      * This factory allows the enum to be obtained from the {@code int} value.
126      *
127      * @param minguoEra  the BEFORE_ROC/ROC value to represent, from 0 (BEFORE_ROC) to 1 (ROC)
128      * @return the era singleton, not null
129      * @throws DateTimeException if the value is invalid
130      */
of(int minguoEra)131     public static MinguoEra of(int minguoEra) {
132         switch (minguoEra) {
133             case 0:
134                 return BEFORE_ROC;
135             case 1:
136                 return ROC;
137             default:
138                 throw new DateTimeException("Invalid era: " + minguoEra);
139         }
140     }
141 
142     //-----------------------------------------------------------------------
143     /**
144      * Gets the numeric era {@code int} value.
145      * <p>
146      * The era BEFORE_ROC has the value 0, while the era ROC has the value 1.
147      *
148      * @return the era value, from 0 (BEFORE_ROC) to 1 (ROC)
149      */
150     @Override
getValue()151     public int getValue() {
152         return ordinal();
153     }
154 
155 }
156