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.io.DataInput;
65 import java.io.DataOutput;
66 import java.io.IOException;
67 import java.time.DateTimeException;
68
69 /**
70 * An era in the Minguo calendar system.
71 * <p>
72 * The Minguo calendar system has two eras.
73 * The current era, for years from 1 onwards, is known as the 'Republic of China' era.
74 * All previous years, zero or earlier in the proleptic count or one and greater
75 * in the year-of-era count, are part of the 'Before Republic of China' era.
76 * <p>
77 * <table summary="Minguo years and eras" cellpadding="2" cellspacing="3" border="0" >
78 * <thead>
79 * <tr class="tableSubHeadingColor">
80 * <th class="colFirst" align="left">year-of-era</th>
81 * <th class="colFirst" align="left">era</th>
82 * <th class="colFirst" align="left">proleptic-year</th>
83 * <th class="colLast" align="left">ISO proleptic-year</th>
84 * </tr>
85 * </thead>
86 * <tbody>
87 * <tr class="rowColor">
88 * <td>2</td><td>ROC</td><td>2</td><td>1913</td>
89 * </tr>
90 * <tr class="altColor">
91 * <td>1</td><td>ROC</td><td>1</td><td>1912</td>
92 * </tr>
93 * <tr class="rowColor">
94 * <td>1</td><td>BEFORE_ROC</td><td>0</td><td>1911</td>
95 * </tr>
96 * <tr class="altColor">
97 * <td>2</td><td>BEFORE_ROC</td><td>-1</td><td>1910</td>
98 * </tr>
99 * </tbody>
100 * </table>
101 * <p>
102 * <b>Do not use {@code ordinal()} to obtain the numeric representation of {@code MinguoEra}.
103 * Use {@code getValue()} instead.</b>
104 *
105 * <h3>Specification for implementors</h3>
106 * This is an immutable and thread-safe enum.
107 *
108 * @since 1.8
109 */
110 public enum MinguoEra implements Era {
111
112 /**
113 * The singleton instance for the era before the current one, 'Before Republic of China Era',
114 * which has the numeric value 0.
115 */
116 BEFORE_ROC,
117 /**
118 * The singleton instance for the current era, 'Republic of China Era',
119 * which has the numeric value 1.
120 */
121 ROC;
122
123 //-----------------------------------------------------------------------
124 /**
125 * Obtains an instance of {@code MinguoEra} from an {@code int} value.
126 * <p>
127 * {@code MinguoEra} is an enum representing the Minguo eras of BEFORE_ROC/ROC.
128 * This factory allows the enum to be obtained from the {@code int} value.
129 *
130 * @param minguoEra the BEFORE_ROC/ROC value to represent, from 0 (BEFORE_ROC) to 1 (ROC)
131 * @return the era singleton, not null
132 * @throws DateTimeException if the value is invalid
133 */
134 public static MinguoEra of(int minguoEra) {
135 switch (minguoEra) {
136 case 0:
137 return BEFORE_ROC;
138 case 1:
139 return ROC;
140 default:
141 throw new DateTimeException("Invalid era: " + minguoEra);
142 }
143 }
144
145 //-----------------------------------------------------------------------
146 /**
147 * Gets the numeric era {@code int} value.
148 * <p>
149 * The era BEFORE_ROC has the value 0, while the era ROC has the value 1.
150 *
151 * @return the era value, from 0 (BEFORE_ROC) to 1 (ROC)
152 */
153 @Override
154 public int getValue() {
155 return ordinal();
156 }
157
158 //-----------------------------------------------------------------------
159 private Object writeReplace() {
160 return new Ser(Ser.MINGUO_ERA_TYPE, this);
161 }
162
163 void writeExternal(DataOutput out) throws IOException {
164 out.writeByte(this.getValue());
165 }
166
167 static MinguoEra readExternal(DataInput in) throws IOException {
168 byte eraValue = in.readByte();
169 return MinguoEra.of(eraValue);
170 }
171
172 }