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 static java.time.temporal.ChronoField.YEAR;
  60 
  61 import java.io.Serializable;
  62 import java.time.Clock;
  63 import java.time.DateTimeException;
  64 import java.time.Instant;
  65 import java.time.LocalDate;
  66 import java.time.ZoneId;
  67 import java.time.temporal.ChronoField;
  68 import java.time.temporal.TemporalAccessor;
  69 import java.time.temporal.ValueRange;
  70 import java.util.Arrays;
  71 import java.util.HashMap;
  72 import java.util.List;
  73 import java.util.Locale;
  74 
  75 /**
  76  * The Thai Buddhist calendar system.
  77  * <p>
  78  * This chronology defines the rules of the Thai Buddhist calendar system.
  79  * This calendar system is primarily used in Thailand.
  80  * Dates are aligned such that {@code 2484-01-01 (Buddhist)} is {@code 1941-01-01 (ISO)}.
  81  * <p>
  82  * The fields are defined as follows:
  83  * <p><ul>
  84  * <li>era - There are two eras, the current 'Buddhist' (ERA_BE) and the previous era (ERA_BEFORE_BE).
  85  * <li>year-of-era - The year-of-era for the current era increases uniformly from the epoch at year one.
  86  *  For the previous era the year increases from one as time goes backwards.
  87  *  The value for the current era is equal to the ISO proleptic-year plus 543.
  88  * <li>proleptic-year - The proleptic year is the same as the year-of-era for the
  89  *  current era. For the previous era, years have zero, then negative values.
  90  *  The value is equal to the ISO proleptic-year plus 543.
  91  * <li>month-of-year - The ThaiBuddhist month-of-year exactly matches ISO.
  92  * <li>day-of-month - The ThaiBuddhist day-of-month exactly matches ISO.
  93  * <li>day-of-year - The ThaiBuddhist day-of-year exactly matches ISO.
  94  * <li>leap-year - The ThaiBuddhist leap-year pattern exactly matches ISO, such that the two calendars
  95  *  are never out of step.
  96  * </ul><p>
  97  *
  98  * <h3>Specification for implementors</h3>
  99  * This class is immutable and thread-safe.
 100  *
 101  * @since 1.8
 102  */
 103 public final class ThaiBuddhistChronology extends Chronology implements Serializable {
 104 
 105     /**
 106      * Singleton instance of the Buddhist chronology.
 107      */
 108     public static final ThaiBuddhistChronology INSTANCE = new ThaiBuddhistChronology();
 109     /**
 110      * The singleton instance for the era before the current one - Before Buddhist -
 111      * which has the value 0.
 112      */
 113     public static final Era ERA_BEFORE_BE = ThaiBuddhistEra.BEFORE_BE;
 114     /**
 115      * The singleton instance for the current era - Buddhist - which has the value 1.
 116      */
 117     public static final Era ERA_BE = ThaiBuddhistEra.BE;
 118 
 119     /**
 120      * Serialization version.
 121      */
 122     private static final long serialVersionUID = 2775954514031616474L;
 123     /**
 124      * Containing the offset to add to the ISO year.
 125      */
 126     static final int YEARS_DIFFERENCE = 543;
 127     /**
 128      * Narrow names for eras.
 129      */
 130     private static final HashMap<String, String[]> ERA_NARROW_NAMES = new HashMap<>();
 131     /**
 132      * Short names for eras.
 133      */
 134     private static final HashMap<String, String[]> ERA_SHORT_NAMES = new HashMap<>();
 135     /**
 136      * Full names for eras.
 137      */
 138     private static final HashMap<String, String[]> ERA_FULL_NAMES = new HashMap<>();
 139     /**
 140      * Fallback language for the era names.
 141      */
 142     private static final String FALLBACK_LANGUAGE = "en";
 143     /**
 144      * Language that has the era names.
 145      */
 146     private static final String TARGET_LANGUAGE = "th";
 147     /**
 148      * Name data.
 149      */
 150     static {
 151         ERA_NARROW_NAMES.put(FALLBACK_LANGUAGE, new String[]{"BB", "BE"});
 152         ERA_NARROW_NAMES.put(TARGET_LANGUAGE, new String[]{"BB", "BE"});
 153         ERA_SHORT_NAMES.put(FALLBACK_LANGUAGE, new String[]{"B.B.", "B.E."});
 154         ERA_SHORT_NAMES.put(TARGET_LANGUAGE,
 155                 new String[]{"\u0e1e.\u0e28.",
 156                 "\u0e1b\u0e35\u0e01\u0e48\u0e2d\u0e19\u0e04\u0e23\u0e34\u0e2a\u0e15\u0e4c\u0e01\u0e32\u0e25\u0e17\u0e35\u0e48"});
 157         ERA_FULL_NAMES.put(FALLBACK_LANGUAGE, new String[]{"Before Buddhist", "Budhhist Era"});
 158         ERA_FULL_NAMES.put(TARGET_LANGUAGE,
 159                 new String[]{"\u0e1e\u0e38\u0e17\u0e18\u0e28\u0e31\u0e01\u0e23\u0e32\u0e0a",
 160                 "\u0e1b\u0e35\u0e01\u0e48\u0e2d\u0e19\u0e04\u0e23\u0e34\u0e2a\u0e15\u0e4c\u0e01\u0e32\u0e25\u0e17\u0e35\u0e48"});
 161     }
 162 
 163     /**
 164      * Restricted constructor.
 165      */
 166     private ThaiBuddhistChronology() {
 167     }
 168 
 169     /**
 170      * Resolve singleton.
 171      *
 172      * @return the singleton instance, not null
 173      */
 174     private Object readResolve() {
 175         return INSTANCE;
 176     }
 177 
 178     //-----------------------------------------------------------------------
 179     /**
 180      * Gets the ID of the chronology - 'ThaiBuddhist'.
 181      * <p>
 182      * The ID uniquely identifies the {@code Chronology}.
 183      * It can be used to lookup the {@code Chronology} using {@link #of(String)}.
 184      *
 185      * @return the chronology ID - 'ThaiBuddhist'
 186      * @see #getCalendarType()
 187      */
 188     @Override
 189     public String getId() {
 190         return "ThaiBuddhist";
 191     }
 192 
 193     /**
 194      * Gets the calendar type of the underlying calendar system - 'buddhist'.
 195      * <p>
 196      * The calendar type is an identifier defined by the
 197      * <em>Unicode Locale Data Markup Language (LDML)</em> specification.
 198      * It can be used to lookup the {@code Chronology} using {@link #of(String)}.
 199      * It can also be used as part of a locale, accessible via
 200      * {@link Locale#getUnicodeLocaleType(String)} with the key 'ca'.
 201      *
 202      * @return the calendar system type - 'buddhist'
 203      * @see #getId()
 204      */
 205     @Override
 206     public String getCalendarType() {
 207         return "buddhist";
 208     }
 209 
 210     //-----------------------------------------------------------------------
 211     @Override
 212     public ThaiBuddhistDate date(int prolepticYear, int month, int dayOfMonth) {
 213         return new ThaiBuddhistDate(LocalDate.of(prolepticYear - YEARS_DIFFERENCE, month, dayOfMonth));
 214     }
 215 
 216     @Override
 217     public ThaiBuddhistDate dateYearDay(int prolepticYear, int dayOfYear) {
 218         return new ThaiBuddhistDate(LocalDate.ofYearDay(prolepticYear - YEARS_DIFFERENCE, dayOfYear));
 219     }
 220 
 221     @Override
 222     public ThaiBuddhistDate date(TemporalAccessor temporal) {
 223         if (temporal instanceof ThaiBuddhistDate) {
 224             return (ThaiBuddhistDate) temporal;
 225         }
 226         return new ThaiBuddhistDate(LocalDate.from(temporal));
 227     }
 228     @Override
 229     public ThaiBuddhistDate date(Era era, int yearOfEra, int month, int dayOfMonth) {
 230         return date(prolepticYear(era, yearOfEra), month, dayOfMonth);
 231 
 232     }
 233 
 234     @Override
 235     public ThaiBuddhistDate dateYearDay(Era era, int yearOfEra, int dayOfYear) {
 236         return dateYearDay(prolepticYear(era, yearOfEra), dayOfYear);
 237     }
 238 
 239     @Override
 240     public ThaiBuddhistDate dateNow() {
 241         return dateNow(Clock.systemDefaultZone());
 242     }
 243 
 244     @Override
 245     public ThaiBuddhistDate dateNow(ZoneId zone) {
 246         return dateNow(Clock.system(zone));
 247     }
 248 
 249     @Override
 250     public ThaiBuddhistDate dateNow(Clock clock) {
 251         return date(LocalDate.now(clock));
 252     }
 253 
 254     @Override
 255     public ChronoLocalDateTime<ThaiBuddhistDate> localDateTime(TemporalAccessor temporal) {
 256         return (ChronoLocalDateTime<ThaiBuddhistDate>)super.localDateTime(temporal);
 257     }
 258 
 259     @Override
 260     public ChronoZonedDateTime<ThaiBuddhistDate> zonedDateTime(TemporalAccessor temporal) {
 261         return (ChronoZonedDateTime<ThaiBuddhistDate>)super.zonedDateTime(temporal);
 262     }
 263 
 264     @Override
 265     public ChronoZonedDateTime<ThaiBuddhistDate> zonedDateTime(Instant instant, ZoneId zone) {
 266         return (ChronoZonedDateTime<ThaiBuddhistDate>)super.zonedDateTime(instant, zone);
 267     }
 268 
 269     //-----------------------------------------------------------------------
 270     /**
 271      * Checks if the specified year is a leap year.
 272      * <p>
 273      * Thai Buddhist leap years occur exactly in line with ISO leap years.
 274      * This method does not validate the year passed in, and only has a
 275      * well-defined result for years in the supported range.
 276      *
 277      * @param prolepticYear  the proleptic-year to check, not validated for range
 278      * @return true if the year is a leap year
 279      */
 280     @Override
 281     public boolean isLeapYear(long prolepticYear) {
 282         return IsoChronology.INSTANCE.isLeapYear(prolepticYear - YEARS_DIFFERENCE);
 283     }
 284 
 285     @Override
 286     public int prolepticYear(Era era, int yearOfEra) {
 287         if (era instanceof ThaiBuddhistEra == false) {
 288             throw new DateTimeException("Era must be BuddhistEra");
 289         }
 290         return (era == ThaiBuddhistEra.BE ? yearOfEra : 1 - yearOfEra);
 291     }
 292 
 293     @Override
 294     public Era eraOf(int eraValue) {
 295         return ThaiBuddhistEra.of(eraValue);
 296     }
 297 
 298     @Override
 299     public List<Era> eras() {
 300         return Arrays.<Era>asList(ThaiBuddhistEra.values());
 301     }
 302 
 303     //-----------------------------------------------------------------------
 304     @Override
 305     public ValueRange range(ChronoField field) {
 306         switch (field) {
 307             case YEAR_OF_ERA: {
 308                 ValueRange range = YEAR.range();
 309                 return ValueRange.of(1, -(range.getMinimum() + YEARS_DIFFERENCE) + 1, range.getMaximum() + YEARS_DIFFERENCE);
 310             }
 311             case YEAR: {
 312                 ValueRange range = YEAR.range();
 313                 return ValueRange.of(range.getMinimum() + YEARS_DIFFERENCE, range.getMaximum() + YEARS_DIFFERENCE);
 314             }
 315         }
 316         return field.range();
 317     }
 318 
 319 }