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.List;
  72 import java.util.Locale;
  73 
  74 /**
  75  * The Minguo calendar system.
  76  * <p>
  77  * This chronology defines the rules of the Minguo calendar system.
  78  * This calendar system is primarily used in the Republic of China, often known as Taiwan.
  79  * Dates are aligned such that {@code 0001-01-01 (Minguo)} is {@code 1912-01-01 (ISO)}.
  80  * <p>
  81  * The fields are defined as follows:
  82  * <p><ul>
  83  * <li>era - There are two eras, the current 'Republic' (ERA_ROC) and the previous era (ERA_BEFORE_ROC).
  84  * <li>year-of-era - The year-of-era for the current era increases uniformly from the epoch at year one.
  85  *  For the previous era the year increases from one as time goes backwards.
  86  *  The value for the current era is equal to the ISO proleptic-year minus 1911.
  87  * <li>proleptic-year - The proleptic year is the same as the year-of-era for the
  88  *  current era. For the previous era, years have zero, then negative values.
  89  *  The value is equal to the ISO proleptic-year minus 1911.
  90  * <li>month-of-year - The Minguo month-of-year exactly matches ISO.
  91  * <li>day-of-month - The Minguo day-of-month exactly matches ISO.
  92  * <li>day-of-year - The Minguo day-of-year exactly matches ISO.
  93  * <li>leap-year - The Minguo leap-year pattern exactly matches ISO, such that the two calendars
  94  *  are never out of step.
  95  * </ul><p>
  96  *
  97  * <h3>Specification for implementors</h3>
  98  * This class is immutable and thread-safe.
  99  *
 100  * @since 1.8
 101  */
 102 public final class MinguoChronology extends Chronology implements Serializable {
 103 
 104     /**
 105      * Singleton instance for the Minguo chronology.
 106      */
 107     public static final MinguoChronology INSTANCE = new MinguoChronology();
 108 
 109     /**
 110      * The singleton instance for the era ROC.
 111      */
 112     public static final Era ERA_ROC = MinguoEra.ROC;
 113 
 114     /**
 115      * The singleton instance for the era BEFORE_ROC.
 116      */
 117     public static final Era ERA_BEFORE_ROC = MinguoEra.BEFORE_ROC;
 118 
 119     /**
 120      * Serialization version.
 121      */
 122     private static final long serialVersionUID = 1039765215346859963L;
 123     /**
 124      * The difference in years between ISO and Minguo.
 125      */
 126     static final int YEARS_DIFFERENCE = 1911;
 127 
 128     /**
 129      * Restricted constructor.
 130      */
 131     private MinguoChronology() {
 132     }
 133 
 134     /**
 135      * Resolve singleton.
 136      *
 137      * @return the singleton instance, not null
 138      */
 139     private Object readResolve() {
 140         return INSTANCE;
 141     }
 142 
 143     //-----------------------------------------------------------------------
 144     /**
 145      * Gets the ID of the chronology - 'Minguo'.
 146      * <p>
 147      * The ID uniquely identifies the {@code Chronology}.
 148      * It can be used to lookup the {@code Chronology} using {@link #of(String)}.
 149      *
 150      * @return the chronology ID - 'Minguo'
 151      * @see #getCalendarType()
 152      */
 153     @Override
 154     public String getId() {
 155         return "Minguo";
 156     }
 157 
 158     /**
 159      * Gets the calendar type of the underlying calendar system - 'roc'.
 160      * <p>
 161      * The calendar type is an identifier defined by the
 162      * <em>Unicode Locale Data Markup Language (LDML)</em> specification.
 163      * It can be used to lookup the {@code Chronology} using {@link #of(String)}.
 164      * It can also be used as part of a locale, accessible via
 165      * {@link Locale#getUnicodeLocaleType(String)} with the key 'ca'.
 166      *
 167      * @return the calendar system type - 'roc'
 168      * @see #getId()
 169      */
 170     @Override
 171     public String getCalendarType() {
 172         return "roc";
 173     }
 174 
 175     //-----------------------------------------------------------------------
 176     @Override
 177     public MinguoDate date(int prolepticYear, int month, int dayOfMonth) {
 178         return new MinguoDate(LocalDate.of(prolepticYear + YEARS_DIFFERENCE, month, dayOfMonth));
 179     }
 180 
 181     @Override
 182     public MinguoDate dateYearDay(int prolepticYear, int dayOfYear) {
 183         return new MinguoDate(LocalDate.ofYearDay(prolepticYear + YEARS_DIFFERENCE, dayOfYear));
 184     }
 185 
 186     @Override
 187     public MinguoDate date(TemporalAccessor temporal) {
 188         if (temporal instanceof MinguoDate) {
 189             return (MinguoDate) temporal;
 190         }
 191         return new MinguoDate(LocalDate.from(temporal));
 192     }
 193     @Override
 194     public MinguoDate date(Era era, int yearOfEra, int month, int dayOfMonth) {
 195         return date(prolepticYear(era, yearOfEra), month, dayOfMonth);
 196 
 197     }
 198 
 199     @Override
 200     public MinguoDate dateYearDay(Era era, int yearOfEra, int dayOfYear) {
 201         return dateYearDay(prolepticYear(era, yearOfEra), dayOfYear);
 202     }
 203 
 204     @Override
 205     public MinguoDate dateNow() {
 206         return dateNow(Clock.systemDefaultZone());
 207     }
 208 
 209     @Override
 210     public MinguoDate dateNow(ZoneId zone) {
 211         return dateNow(Clock.system(zone));
 212     }
 213 
 214     @Override
 215     public MinguoDate dateNow(Clock clock) {
 216         return date(LocalDate.now(clock));
 217     }
 218 
 219     @Override
 220     public ChronoLocalDateTime<MinguoDate> localDateTime(TemporalAccessor temporal) {
 221         return (ChronoLocalDateTime<MinguoDate>)super.localDateTime(temporal);
 222     }
 223 
 224     @Override
 225     public ChronoZonedDateTime<MinguoDate> zonedDateTime(TemporalAccessor temporal) {
 226         return (ChronoZonedDateTime<MinguoDate>)super.zonedDateTime(temporal);
 227     }
 228 
 229     @Override
 230     public ChronoZonedDateTime<MinguoDate> zonedDateTime(Instant instant, ZoneId zone) {
 231         return (ChronoZonedDateTime<MinguoDate>)super.zonedDateTime(instant, zone);
 232     }
 233 
 234     //-----------------------------------------------------------------------
 235     /**
 236      * Checks if the specified year is a leap year.
 237      * <p>
 238      * Minguo leap years occur exactly in line with ISO leap years.
 239      * This method does not validate the year passed in, and only has a
 240      * well-defined result for years in the supported range.
 241      *
 242      * @param prolepticYear  the proleptic-year to check, not validated for range
 243      * @return true if the year is a leap year
 244      */
 245     @Override
 246     public boolean isLeapYear(long prolepticYear) {
 247         return IsoChronology.INSTANCE.isLeapYear(prolepticYear + YEARS_DIFFERENCE);
 248     }
 249 
 250     @Override
 251     public int prolepticYear(Era era, int yearOfEra) {
 252         if (era instanceof MinguoEra == false) {
 253             throw new DateTimeException("Era must be MinguoEra");
 254         }
 255         return (era == MinguoEra.ROC ? yearOfEra : 1 - yearOfEra);
 256     }
 257 
 258     @Override
 259     public Era eraOf(int eraValue) {
 260         return MinguoEra.of(eraValue);
 261     }
 262 
 263     @Override
 264     public List<Era> eras() {
 265         return Arrays.<Era>asList(MinguoEra.values());
 266     }
 267 
 268     //-----------------------------------------------------------------------
 269     @Override
 270     public ValueRange range(ChronoField field) {
 271         switch (field) {
 272             case YEAR_OF_ERA: {
 273                 ValueRange range = YEAR.range();
 274                 return ValueRange.of(1, range.getMaximum() - YEARS_DIFFERENCE, -range.getMinimum() + 1 + YEARS_DIFFERENCE);
 275             }
 276             case YEAR: {
 277                 ValueRange range = YEAR.range();
 278                 return ValueRange.of(range.getMinimum() - YEARS_DIFFERENCE, range.getMaximum() - YEARS_DIFFERENCE);
 279             }
 280         }
 281         return field.range();
 282     }
 283 
 284 }