1 /*
2 * Copyright (c) 2012, 2023, 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 static java.time.chrono.ThaiBuddhistChronology.YEARS_DIFFERENCE;
60 import static java.time.temporal.ChronoField.DAY_OF_MONTH;
61 import static java.time.temporal.ChronoField.MONTH_OF_YEAR;
62 import static java.time.temporal.ChronoField.YEAR;
63
64 import java.io.DataInput;
65 import java.io.DataOutput;
66 import java.io.IOException;
67 import java.io.InvalidObjectException;
68 import java.io.ObjectInputStream;
69 import java.io.Serializable;
70 import java.time.Clock;
71 import java.time.DateTimeException;
72 import java.time.LocalDate;
73 import java.time.LocalTime;
74 import java.time.Period;
75 import java.time.ZoneId;
76 import java.time.temporal.ChronoField;
77 import java.time.temporal.TemporalAccessor;
78 import java.time.temporal.TemporalAdjuster;
79 import java.time.temporal.TemporalAmount;
80 import java.time.temporal.TemporalField;
81 import java.time.temporal.TemporalQuery;
82 import java.time.temporal.TemporalUnit;
83 import java.time.temporal.UnsupportedTemporalTypeException;
84 import java.time.temporal.ValueRange;
85 import java.util.Objects;
86
87 /**
88 * A date in the Thai Buddhist calendar system.
89 * <p>
90 * This date operates using the {@linkplain ThaiBuddhistChronology Thai Buddhist calendar}.
91 * This calendar system is primarily used in Thailand.
92 * Dates are aligned such that {@code 2484-01-01 (Buddhist)} is {@code 1941-01-01 (ISO)}.
93 * <p>
94 * This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>
95 * class; programmers should treat instances that are {@linkplain #equals(Object) equal}
96 * as interchangeable and should not use instances for synchronization, mutexes, or
97 * with {@linkplain java.lang.ref.Reference object references}.
98 *
99 * <div class="preview-block">
100 * <div class="preview-comment">
101 * When preview features are enabled, {@code ThaiBuddistDate} is a {@linkplain Class#isValue value class}.
102 * Use of value class instances for synchronization, mutexes, or with
103 * {@linkplain java.lang.ref.Reference object references} result in
104 * {@link IdentityException}.
105 * </div>
106 * </div>
107 *
108 * @implSpec
109 * This class is immutable and thread-safe.
110 *
111 * @since 1.8
112 */
113 @jdk.internal.ValueBased
114 @jdk.internal.MigratedValueClass
115 public final class ThaiBuddhistDate
116 extends ChronoLocalDateImpl<ThaiBuddhistDate>
117 implements ChronoLocalDate, Serializable {
118
119 /**
120 * Serialization version.
121 */
122 @java.io.Serial
123 private static final long serialVersionUID = -8722293800195731463L;
124
125 /**
126 * The underlying date.
127 */
128 private final transient LocalDate isoDate;
129
130 //-----------------------------------------------------------------------
131 /**
132 * Obtains the current {@code ThaiBuddhistDate} from the system clock in the default time-zone.
133 * <p>
134 * This will query the {@link Clock#systemDefaultZone() system clock} in the default
135 * time-zone to obtain the current date.
136 * <p>
137 * Using this method will prevent the ability to use an alternate clock for testing
138 * because the clock is hard-coded.
139 *
140 * @return the current date using the system clock and default time-zone, not null
141 */
142 public static ThaiBuddhistDate now() {
143 return now(Clock.systemDefaultZone());
144 }
145
146 /**
147 * Obtains the current {@code ThaiBuddhistDate} from the system clock in the specified time-zone.
148 * <p>
149 * This will query the {@link Clock#system(ZoneId) system clock} to obtain the current date.
150 * Specifying the time-zone avoids dependence on the default time-zone.
151 * <p>
152 * Using this method will prevent the ability to use an alternate clock for testing
153 * because the clock is hard-coded.
154 *
155 * @param zone the zone ID to use, not null
156 * @return the current date using the system clock, not null
157 */
158 public static ThaiBuddhistDate now(ZoneId zone) {
159 return now(Clock.system(zone));
160 }
161
162 /**
163 * Obtains the current {@code ThaiBuddhistDate} from the specified clock.
164 * <p>
165 * This will query the specified clock to obtain the current date - today.
166 * Using this method allows the use of an alternate clock for testing.
167 * The alternate clock may be introduced using {@linkplain Clock dependency injection}.
168 *
169 * @param clock the clock to use, not null
170 * @return the current date, not null
171 * @throws DateTimeException if the current date cannot be obtained
172 */
173 public static ThaiBuddhistDate now(Clock clock) {
174 return new ThaiBuddhistDate(LocalDate.now(clock));
175 }
176
177 /**
178 * Obtains a {@code ThaiBuddhistDate} representing a date in the Thai Buddhist calendar
179 * system from the proleptic-year, month-of-year and day-of-month fields.
180 * <p>
181 * This returns a {@code ThaiBuddhistDate} with the specified fields.
182 * The day must be valid for the year and month, otherwise an exception will be thrown.
183 *
184 * @param prolepticYear the Thai Buddhist proleptic-year
185 * @param month the Thai Buddhist month-of-year, from 1 to 12
186 * @param dayOfMonth the Thai Buddhist day-of-month, from 1 to 31
187 * @return the date in Thai Buddhist calendar system, not null
188 * @throws DateTimeException if the value of any field is out of range,
189 * or if the day-of-month is invalid for the month-year
190 */
191 public static ThaiBuddhistDate of(int prolepticYear, int month, int dayOfMonth) {
192 return new ThaiBuddhistDate(LocalDate.of(prolepticYear - YEARS_DIFFERENCE, month, dayOfMonth));
193 }
194
195 /**
196 * Obtains a {@code ThaiBuddhistDate} from a temporal object.
197 * <p>
198 * This obtains a date in the Thai Buddhist calendar system based on the specified temporal.
199 * A {@code TemporalAccessor} represents an arbitrary set of date and time information,
200 * which this factory converts to an instance of {@code ThaiBuddhistDate}.
201 * <p>
202 * The conversion typically uses the {@link ChronoField#EPOCH_DAY EPOCH_DAY}
203 * field, which is standardized across calendar systems.
204 * <p>
205 * This method matches the signature of the functional interface {@link TemporalQuery}
206 * allowing it to be used as a query via method reference, {@code ThaiBuddhistDate::from}.
207 *
208 * @param temporal the temporal object to convert, not null
209 * @return the date in Thai Buddhist calendar system, not null
210 * @throws DateTimeException if unable to convert to a {@code ThaiBuddhistDate}
211 */
212 public static ThaiBuddhistDate from(TemporalAccessor temporal) {
213 return ThaiBuddhistChronology.INSTANCE.date(temporal);
214 }
215
216 //-----------------------------------------------------------------------
217 /**
218 * Creates an instance from an ISO date.
219 *
220 * @param isoDate the standard local date, validated not null
221 */
222 ThaiBuddhistDate(LocalDate isoDate) {
223 Objects.requireNonNull(isoDate, "isoDate");
224 this.isoDate = isoDate;
225 }
226
227 //-----------------------------------------------------------------------
228 /**
229 * Gets the chronology of this date, which is the Thai Buddhist calendar system.
230 * <p>
231 * The {@code Chronology} represents the calendar system in use.
232 * The era and other fields in {@link ChronoField} are defined by the chronology.
233 *
234 * @return the Thai Buddhist chronology, not null
235 */
236 @Override
237 public ThaiBuddhistChronology getChronology() {
238 return ThaiBuddhistChronology.INSTANCE;
239 }
240
241 /**
242 * Gets the era applicable at this date.
243 * <p>
244 * The Thai Buddhist calendar system has two eras, 'BE' and 'BEFORE_BE',
245 * defined by {@link ThaiBuddhistEra}.
246 *
247 * @return the era applicable at this date, not null
248 */
249 @Override
250 public ThaiBuddhistEra getEra() {
251 return (getProlepticYear() >= 1 ? ThaiBuddhistEra.BE : ThaiBuddhistEra.BEFORE_BE);
252 }
253
254 /**
255 * Returns the length of the month represented by this date.
256 * <p>
257 * This returns the length of the month in days.
258 * Month lengths match those of the ISO calendar system.
259 *
260 * @return the length of the month in days
261 */
262 @Override
263 public int lengthOfMonth() {
264 return isoDate.lengthOfMonth();
265 }
266
267 //-----------------------------------------------------------------------
268 @Override
269 public ValueRange range(TemporalField field) {
270 if (field instanceof ChronoField) {
271 if (isSupported(field)) {
272 ChronoField f = (ChronoField) field;
273 switch (f) {
274 case DAY_OF_MONTH:
275 case DAY_OF_YEAR:
276 case ALIGNED_WEEK_OF_MONTH:
277 return isoDate.range(field);
278 case YEAR_OF_ERA: {
279 ValueRange range = YEAR.range();
280 long max = (getProlepticYear() <= 0 ? -(range.getMinimum() + YEARS_DIFFERENCE) + 1 : range.getMaximum() + YEARS_DIFFERENCE);
281 return ValueRange.of(1, max);
282 }
283 }
284 return getChronology().range(f);
285 }
286 throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
287 }
288 return field.rangeRefinedBy(this);
289 }
290
291 @Override
292 public long getLong(TemporalField field) {
293 if (field instanceof ChronoField) {
294 switch ((ChronoField) field) {
295 case PROLEPTIC_MONTH:
296 return getProlepticMonth();
297 case YEAR_OF_ERA: {
298 int prolepticYear = getProlepticYear();
299 return (prolepticYear >= 1 ? prolepticYear : 1 - prolepticYear);
300 }
301 case YEAR:
302 return getProlepticYear();
303 case ERA:
304 return (getProlepticYear() >= 1 ? 1 : 0);
305 }
306 return isoDate.getLong(field);
307 }
308 return field.getFrom(this);
309 }
310
311 private long getProlepticMonth() {
312 return getProlepticYear() * 12L + isoDate.getMonthValue() - 1;
313 }
314
315 private int getProlepticYear() {
316 return isoDate.getYear() + YEARS_DIFFERENCE;
317 }
318
319 //-----------------------------------------------------------------------
320 @Override
321 public ThaiBuddhistDate with(TemporalField field, long newValue) {
322 if (field instanceof ChronoField chronoField) {
323 if (getLong(chronoField) == newValue) {
324 return this;
325 }
326 switch (chronoField) {
327 case PROLEPTIC_MONTH:
328 getChronology().range(chronoField).checkValidValue(newValue, chronoField);
329 return plusMonths(newValue - getProlepticMonth());
330 case YEAR_OF_ERA:
331 case YEAR:
332 case ERA: {
333 int nvalue = getChronology().range(chronoField).checkValidIntValue(newValue, chronoField);
334 switch (chronoField) {
335 case YEAR_OF_ERA:
336 return with(isoDate.withYear((getProlepticYear() >= 1 ? nvalue : 1 - nvalue) - YEARS_DIFFERENCE));
337 case YEAR:
338 return with(isoDate.withYear(nvalue - YEARS_DIFFERENCE));
339 case ERA:
340 return with(isoDate.withYear((1 - getProlepticYear()) - YEARS_DIFFERENCE));
341 }
342 }
343 }
344 return with(isoDate.with(field, newValue));
345 }
346 return super.with(field, newValue);
347 }
348
349 /**
350 * {@inheritDoc}
351 * @throws DateTimeException {@inheritDoc}
352 * @throws ArithmeticException {@inheritDoc}
353 */
354 @Override
355 public ThaiBuddhistDate with(TemporalAdjuster adjuster) {
356 return super.with(adjuster);
357 }
358
359 /**
360 * {@inheritDoc}
361 * @throws DateTimeException {@inheritDoc}
362 * @throws ArithmeticException {@inheritDoc}
363 */
364 @Override
365 public ThaiBuddhistDate plus(TemporalAmount amount) {
366 return super.plus(amount);
367 }
368
369 /**
370 * {@inheritDoc}
371 * @throws DateTimeException {@inheritDoc}
372 * @throws ArithmeticException {@inheritDoc}
373 */
374 @Override
375 public ThaiBuddhistDate minus(TemporalAmount amount) {
376 return super.minus(amount);
377 }
378
379 //-----------------------------------------------------------------------
380 @Override
381 ThaiBuddhistDate plusYears(long years) {
382 return with(isoDate.plusYears(years));
383 }
384
385 @Override
386 ThaiBuddhistDate plusMonths(long months) {
387 return with(isoDate.plusMonths(months));
388 }
389
390 @Override
391 ThaiBuddhistDate plusWeeks(long weeksToAdd) {
392 return super.plusWeeks(weeksToAdd);
393 }
394
395 @Override
396 ThaiBuddhistDate plusDays(long days) {
397 return with(isoDate.plusDays(days));
398 }
399
400 @Override
401 public ThaiBuddhistDate plus(long amountToAdd, TemporalUnit unit) {
402 return super.plus(amountToAdd, unit);
403 }
404
405 @Override
406 public ThaiBuddhistDate minus(long amountToSubtract, TemporalUnit unit) {
407 return super.minus(amountToSubtract, unit);
408 }
409
410 @Override
411 ThaiBuddhistDate minusYears(long yearsToSubtract) {
412 return super.minusYears(yearsToSubtract);
413 }
414
415 @Override
416 ThaiBuddhistDate minusMonths(long monthsToSubtract) {
417 return super.minusMonths(monthsToSubtract);
418 }
419
420 @Override
421 ThaiBuddhistDate minusWeeks(long weeksToSubtract) {
422 return super.minusWeeks(weeksToSubtract);
423 }
424
425 @Override
426 ThaiBuddhistDate minusDays(long daysToSubtract) {
427 return super.minusDays(daysToSubtract);
428 }
429
430 private ThaiBuddhistDate with(LocalDate newDate) {
431 return (newDate.equals(isoDate) ? this : new ThaiBuddhistDate(newDate));
432 }
433
434 @Override // for javadoc and covariant return type
435 @SuppressWarnings("unchecked")
436 public final ChronoLocalDateTime<ThaiBuddhistDate> atTime(LocalTime localTime) {
437 return (ChronoLocalDateTime<ThaiBuddhistDate>) super.atTime(localTime);
438 }
439
440 @Override
441 public ChronoPeriod until(ChronoLocalDate endDate) {
442 Period period = isoDate.until(endDate);
443 return getChronology().period(period.getYears(), period.getMonths(), period.getDays());
444 }
445
446 @Override // override for performance
447 public long toEpochDay() {
448 return isoDate.toEpochDay();
449 }
450
451 //-------------------------------------------------------------------------
452 /**
453 * Compares this date to another date, including the chronology.
454 * <p>
455 * Compares this {@code ThaiBuddhistDate} with another ensuring that the date is the same.
456 * <p>
457 * Only objects of type {@code ThaiBuddhistDate} are compared, other types return false.
458 * To compare the dates of two {@code TemporalAccessor} instances, including dates
459 * in two different chronologies, use {@link ChronoField#EPOCH_DAY} as a comparator.
460 *
461 * @param obj the object to check, null returns false
462 * @return true if this is equal to the other date
463 */
464 @Override // override for performance
465 public boolean equals(Object obj) {
466 if (this == obj) {
467 return true;
468 }
469 return (obj instanceof ThaiBuddhistDate otherDate)
470 && this.isoDate.equals(otherDate.isoDate);
471 }
472
473 /**
474 * A hash code for this date.
475 *
476 * @return a suitable hash code based only on the Chronology and the date
477 */
478 @Override // override for performance
479 public int hashCode() {
480 return getChronology().getId().hashCode() ^ isoDate.hashCode();
481 }
482
483 //-----------------------------------------------------------------------
484 /**
485 * Defend against malicious streams.
486 *
487 * @param s the stream to read
488 * @throws InvalidObjectException always
489 */
490 @java.io.Serial
491 private void readObject(ObjectInputStream s) throws InvalidObjectException {
492 throw new InvalidObjectException("Deserialization via serialization delegate");
493 }
494
495 /**
496 * Writes the object using a
497 * <a href="{@docRoot}/serialized-form.html#java.time.chrono.Ser">dedicated serialized form</a>.
498 * @serialData
499 * <pre>
500 * out.writeByte(10); // identifies a ThaiBuddhistDate
501 * out.writeInt(get(YEAR));
502 * out.writeByte(get(MONTH_OF_YEAR));
503 * out.writeByte(get(DAY_OF_MONTH));
504 * </pre>
505 *
506 * @return the instance of {@code Ser}, not null
507 */
508 @java.io.Serial
509 private Object writeReplace() {
510 return new Ser(Ser.THAIBUDDHIST_DATE_TYPE, this);
511 }
512
513 void writeExternal(DataOutput out) throws IOException {
514 // ThaiBuddhistChronology is implicit in the THAIBUDDHIST_DATE_TYPE
515 out.writeInt(this.get(YEAR));
516 out.writeByte(this.get(MONTH_OF_YEAR));
517 out.writeByte(this.get(DAY_OF_MONTH));
518 }
519
520 static ThaiBuddhistDate readExternal(DataInput in) throws IOException {
521 int year = in.readInt();
522 int month = in.readByte();
523 int dayOfMonth = in.readByte();
524 return ThaiBuddhistChronology.INSTANCE.date(year, month, dayOfMonth);
525 }
526
527 }