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 * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos
28 *
29 * All rights reserved.
30 *
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions are met:
33 *
34 * * Redistributions of source code must retain the above copyright notice,
35 * this list of conditions and the following disclaimer.
36 *
37 * * Redistributions in binary form must reproduce the above copyright notice,
38 * this list of conditions and the following disclaimer in the documentation
39 * and/or other materials provided with the distribution.
40 *
41 * * Neither the name of JSR-310 nor the names of its contributors
42 * may be used to endorse or promote products derived from this software
43 * without specific prior written permission.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
46 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
48 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
49 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
50 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
51 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
52 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
53 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
54 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
55 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 */
57 package java.time.chrono;
58
59 import java.io.InvalidObjectException;
60 import static java.time.temporal.ChronoField.PROLEPTIC_MONTH;
61 import static java.time.temporal.ChronoField.YEAR;
62
63 import java.io.ObjectInputStream;
64 import java.io.Serializable;
65 import java.time.Clock;
66 import java.time.DateTimeException;
67 import java.time.Instant;
68 import java.time.LocalDate;
69 import java.time.ZoneId;
70 import java.time.format.ResolverStyle;
71 import java.time.temporal.ChronoField;
72 import java.time.temporal.TemporalAccessor;
73 import java.time.temporal.TemporalField;
74 import java.time.temporal.ValueRange;
75 import java.util.List;
76 import java.util.Locale;
77 import java.util.Map;
78
79 /**
80 * The Minguo calendar system.
81 * <p>
82 * This chronology defines the rules of the Minguo calendar system.
83 * This calendar system is primarily used in the Republic of China, often known as Taiwan.
84 * Dates are aligned such that {@code 0001-01-01 (Minguo)} is {@code 1912-01-01 (ISO)}.
85 * <p>
86 * The fields are defined as follows:
87 * <ul>
88 * <li>era - There are two eras, the current 'Republic' (ERA_ROC) and the previous era (ERA_BEFORE_ROC).
89 * <li>year-of-era - The year-of-era for the current era increases uniformly from the epoch at year one.
90 * For the previous era the year increases from one as time goes backwards.
91 * The value for the current era is equal to the ISO proleptic-year minus 1911.
92 * <li>proleptic-year - The proleptic year is the same as the year-of-era for the
93 * current era. For the previous era, years have zero, then negative values.
94 * The value is equal to the ISO proleptic-year minus 1911.
95 * <li>month-of-year - The Minguo month-of-year exactly matches ISO.
96 * <li>day-of-month - The Minguo day-of-month exactly matches ISO.
97 * <li>day-of-year - The Minguo day-of-year exactly matches ISO.
98 * <li>leap-year - The Minguo leap-year pattern exactly matches ISO, such that the two calendars
99 * are never out of step.
100 * </ul>
101 *
102 * @implSpec
103 * This class is immutable and thread-safe.
104 *
105 * @since 1.8
106 */
107 public final class MinguoChronology extends AbstractChronology implements Serializable {
108
109 /**
110 * Singleton instance for the Minguo chronology.
111 */
112 public static final MinguoChronology INSTANCE = new MinguoChronology();
113
114 /**
115 * Serialization version.
116 */
117 private static final long serialVersionUID = 1039765215346859963L;
118 /**
119 * The difference in years between ISO and Minguo.
120 */
121 static final int YEARS_DIFFERENCE = 1911;
122
123 /**
124 * Restricted constructor.
125 */
126 private MinguoChronology() {
127 }
128
129 //-----------------------------------------------------------------------
130 /**
131 * Gets the ID of the chronology - 'Minguo'.
132 * <p>
133 * The ID uniquely identifies the {@code Chronology}.
134 * It can be used to lookup the {@code Chronology} using {@link Chronology#of(String)}.
135 *
136 * @return the chronology ID - 'Minguo'
137 * @see #getCalendarType()
138 */
139 @Override
140 public String getId() {
141 return "Minguo";
142 }
143
144 /**
145 * Gets the calendar type of the underlying calendar system - 'roc'.
146 * <p>
147 * The calendar type is an identifier defined by the
148 * <em>Unicode Locale Data Markup Language (LDML)</em> specification.
149 * It can be used to lookup the {@code Chronology} using {@link Chronology#of(String)}.
150 * It can also be used as part of a locale, accessible via
151 * {@link Locale#getUnicodeLocaleType(String)} with the key 'ca'.
152 *
153 * @return the calendar system type - 'roc'
154 * @see #getId()
155 */
156 @Override
157 public String getCalendarType() {
158 return "roc";
159 }
160
161 //-----------------------------------------------------------------------
162 /**
163 * Obtains a local date in Minguo calendar system from the
164 * era, year-of-era, month-of-year and day-of-month fields.
165 *
166 * @param era the Minguo era, not null
167 * @param yearOfEra the year-of-era
168 * @param month the month-of-year
169 * @param dayOfMonth the day-of-month
170 * @return the Minguo local date, not null
171 * @throws DateTimeException if unable to create the date
172 * @throws ClassCastException if the {@code era} is not a {@code MinguoEra}
173 */
174 @Override
175 public MinguoDate date(Era era, int yearOfEra, int month, int dayOfMonth) {
176 return date(prolepticYear(era, yearOfEra), month, dayOfMonth);
177 }
178
179 /**
180 * Obtains a local date in Minguo calendar system from the
181 * proleptic-year, month-of-year and day-of-month fields.
182 *
183 * @param prolepticYear the proleptic-year
184 * @param month the month-of-year
185 * @param dayOfMonth the day-of-month
186 * @return the Minguo local date, not null
187 * @throws DateTimeException if unable to create the date
188 */
189 @Override
190 public MinguoDate date(int prolepticYear, int month, int dayOfMonth) {
191 return new MinguoDate(LocalDate.of(prolepticYear + YEARS_DIFFERENCE, month, dayOfMonth));
192 }
193
194 /**
195 * Obtains a local date in Minguo calendar system from the
196 * era, year-of-era and day-of-year fields.
197 *
198 * @param era the Minguo era, not null
199 * @param yearOfEra the year-of-era
200 * @param dayOfYear the day-of-year
201 * @return the Minguo local date, not null
202 * @throws DateTimeException if unable to create the date
203 * @throws ClassCastException if the {@code era} is not a {@code MinguoEra}
204 */
205 @Override
206 public MinguoDate dateYearDay(Era era, int yearOfEra, int dayOfYear) {
207 return dateYearDay(prolepticYear(era, yearOfEra), dayOfYear);
208 }
209
210 /**
211 * Obtains a local date in Minguo calendar system from the
212 * proleptic-year and day-of-year fields.
213 *
214 * @param prolepticYear the proleptic-year
215 * @param dayOfYear the day-of-year
216 * @return the Minguo local date, not null
217 * @throws DateTimeException if unable to create the date
218 */
219 @Override
220 public MinguoDate dateYearDay(int prolepticYear, int dayOfYear) {
221 return new MinguoDate(LocalDate.ofYearDay(prolepticYear + YEARS_DIFFERENCE, dayOfYear));
222 }
223
224 /**
225 * Obtains a local date in the Minguo calendar system from the epoch-day.
226 *
227 * @param epochDay the epoch day
228 * @return the Minguo local date, not null
229 * @throws DateTimeException if unable to create the date
230 */
231 @Override // override with covariant return type
232 public MinguoDate dateEpochDay(long epochDay) {
233 return new MinguoDate(LocalDate.ofEpochDay(epochDay));
234 }
235
236 @Override
237 public MinguoDate dateNow() {
238 return dateNow(Clock.systemDefaultZone());
239 }
240
241 @Override
242 public MinguoDate dateNow(ZoneId zone) {
243 return dateNow(Clock.system(zone));
244 }
245
246 @Override
247 public MinguoDate dateNow(Clock clock) {
248 return date(LocalDate.now(clock));
249 }
250
251 @Override
252 public MinguoDate date(TemporalAccessor temporal) {
253 if (temporal instanceof MinguoDate) {
254 return (MinguoDate) temporal;
255 }
256 return new MinguoDate(LocalDate.from(temporal));
257 }
258
259 @Override
260 @SuppressWarnings("unchecked")
261 public ChronoLocalDateTime<MinguoDate> localDateTime(TemporalAccessor temporal) {
262 return (ChronoLocalDateTime<MinguoDate>)super.localDateTime(temporal);
263 }
264
265 @Override
266 @SuppressWarnings("unchecked")
267 public ChronoZonedDateTime<MinguoDate> zonedDateTime(TemporalAccessor temporal) {
268 return (ChronoZonedDateTime<MinguoDate>)super.zonedDateTime(temporal);
269 }
270
271 @Override
272 @SuppressWarnings("unchecked")
273 public ChronoZonedDateTime<MinguoDate> zonedDateTime(Instant instant, ZoneId zone) {
274 return (ChronoZonedDateTime<MinguoDate>)super.zonedDateTime(instant, zone);
275 }
276
277 //-----------------------------------------------------------------------
278 /**
279 * Checks if the specified year is a leap year.
280 * <p>
281 * Minguo leap years occur exactly in line with ISO leap years.
282 * This method does not validate the year passed in, and only has a
283 * well-defined result for years in the supported range.
284 *
285 * @param prolepticYear the proleptic-year to check, not validated for range
286 * @return true if the year is a leap year
287 */
288 @Override
289 public boolean isLeapYear(long prolepticYear) {
290 return IsoChronology.INSTANCE.isLeapYear(prolepticYear + YEARS_DIFFERENCE);
291 }
292
293 @Override
294 public int prolepticYear(Era era, int yearOfEra) {
295 if (era instanceof MinguoEra == false) {
296 throw new ClassCastException("Era must be MinguoEra");
297 }
298 return (era == MinguoEra.ROC ? yearOfEra : 1 - yearOfEra);
299 }
300
301 @Override
302 public MinguoEra eraOf(int eraValue) {
303 return MinguoEra.of(eraValue);
304 }
305
306 @Override
307 public List<Era> eras() {
308 return List.of(MinguoEra.values());
309 }
310
311 //-----------------------------------------------------------------------
312 @Override
313 public ValueRange range(ChronoField field) {
314 switch (field) {
315 case PROLEPTIC_MONTH: {
316 ValueRange range = PROLEPTIC_MONTH.range();
317 return ValueRange.of(range.getMinimum() - YEARS_DIFFERENCE * 12L, range.getMaximum() - YEARS_DIFFERENCE * 12L);
318 }
319 case YEAR_OF_ERA: {
320 ValueRange range = YEAR.range();
321 return ValueRange.of(1, range.getMaximum() - YEARS_DIFFERENCE, -range.getMinimum() + 1 + YEARS_DIFFERENCE);
322 }
323 case YEAR: {
324 ValueRange range = YEAR.range();
325 return ValueRange.of(range.getMinimum() - YEARS_DIFFERENCE, range.getMaximum() - YEARS_DIFFERENCE);
326 }
327 }
328 return field.range();
329 }
330
331 //-----------------------------------------------------------------------
332 @Override // override for return type
333 public MinguoDate resolveDate(Map<TemporalField, Long> fieldValues, ResolverStyle resolverStyle) {
334 return (MinguoDate) super.resolveDate(fieldValues, resolverStyle);
335 }
336
337 //-----------------------------------------------------------------------
338 /**
339 * Writes the Chronology using a
340 * <a href="../../../serialized-form.html#java.time.chrono.Ser">dedicated serialized form</a>.
341 * @serialData
342 * <pre>
343 * out.writeByte(1); // identifies a Chronology
344 * out.writeUTF(getId());
345 * </pre>
346 *
347 * @return the instance of {@code Ser}, not null
348 */
349 @Override
350 Object writeReplace() {
351 return super.writeReplace();
352 }
353
354 /**
355 * Defend against malicious streams.
356 *
357 * @param s the stream to read
358 * @throws InvalidObjectException always
359 */
360 private void readObject(ObjectInputStream s) throws InvalidObjectException {
361 throw new InvalidObjectException("Deserialization via serialization delegate");
362 }
363 }
364