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.calendar;
  58 
  59 import static java.time.temporal.ChronoField.ERA;
  60 
  61 import java.io.DataInput;
  62 import java.io.DataOutput;
  63 import java.io.IOException;
  64 import java.time.DateTimeException;
  65 import java.time.format.DateTimeFormatterBuilder;
  66 import java.time.format.TextStyle;
  67 import java.time.temporal.ChronoField;
  68 import java.time.temporal.ChronoLocalDate;
  69 import java.time.temporal.Era;
  70 import java.time.temporal.Temporal;
  71 import java.time.temporal.TemporalField;
  72 import java.time.temporal.ValueRange;
  73 import java.util.Locale;
  74 
  75 /**
  76  * An era in the Thai Buddhist calendar system.
  77  * <p>
  78  * The Thai Buddhist calendar system has two eras.
  79  * <p>
  80  * <b>Do not use ordinal() to obtain the numeric representation of a ThaiBuddhistEra
  81  * instance. Use getValue() instead.</b>
  82  *
  83  * <h3>Specification for implementors</h3>
  84  * This is an immutable and thread-safe enum.
  85  *
  86  * @since 1.8
  87  */
  88 enum ThaiBuddhistEra implements Era<ThaiBuddhistChrono> {
  89 
  90     /**
  91      * The singleton instance for the era before the current one, 'Before Buddhist Era',
  92      * which has the value 0.
  93      */
  94     BEFORE_BE,
  95     /**
  96      * The singleton instance for the current era, 'Buddhist Era', which has the value 1.
  97      */
  98     BE;
  99 
 100     //-----------------------------------------------------------------------
 101     /**
 102      * Obtains an instance of {@code ThaiBuddhistEra} from a value.
 103      * <p>
 104      * The current era (from ISO year -543 onwards) has the value 1
 105      * The previous era has the value 0.
 106      *
 107      * @param thaiBuddhistEra  the era to represent, from 0 to 1
 108      * @return the BuddhistEra singleton, never null
 109      * @throws IllegalCalendarFieldValueException if the era is invalid
 110      */
 111     public static ThaiBuddhistEra of(int thaiBuddhistEra) {
 112         switch (thaiBuddhistEra) {
 113             case 0:
 114                 return BEFORE_BE;
 115             case 1:
 116                 return BE;
 117             default:
 118                 throw new DateTimeException("Era is not valid for ThaiBuddhistEra");
 119         }
 120     }
 121 
 122     //-----------------------------------------------------------------------
 123     /**
 124      * Gets the era numeric value.
 125      * <p>
 126      * The current era (from ISO year -543 onwards) has the value 1
 127      * The previous era has the value 0.
 128      *
 129      * @return the era value, from 0 (BEFORE_BE) to 1 (BE)
 130      */
 131     @Override
 132     public int getValue() {
 133         return ordinal();
 134     }
 135 
 136     @Override
 137     public ThaiBuddhistChrono getChrono() {
 138         return ThaiBuddhistChrono.INSTANCE;
 139     }
 140 
 141     // JDK8 default methods:
 142     //-----------------------------------------------------------------------
 143     @Override
 144     public ChronoLocalDate<ThaiBuddhistChrono> date(int year, int month, int day) {
 145         return getChrono().date(this, year, month, day);
 146     }
 147 
 148     @Override
 149     public ChronoLocalDate<ThaiBuddhistChrono> dateYearDay(int year, int dayOfYear) {
 150         return getChrono().dateYearDay(this, year, dayOfYear);
 151     }
 152 
 153     //-----------------------------------------------------------------------
 154     @Override
 155     public boolean isSupported(TemporalField field) {
 156         if (field instanceof ChronoField) {
 157             return field == ERA;
 158         }
 159         return field != null && field.doIsSupported(this);
 160     }
 161 
 162     @Override
 163     public ValueRange range(TemporalField field) {
 164         if (field == ERA) {
 165             return field.range();
 166         } else if (field instanceof ChronoField) {
 167             throw new DateTimeException("Unsupported field: " + field.getName());
 168         }
 169         return field.doRange(this);
 170     }
 171 
 172     @Override
 173     public int get(TemporalField field) {
 174         if (field == ERA) {
 175             return getValue();
 176         }
 177         return range(field).checkValidIntValue(getLong(field), field);
 178     }
 179 
 180     @Override
 181     public long getLong(TemporalField field) {
 182         if (field == ERA) {
 183             return getValue();
 184         } else if (field instanceof ChronoField) {
 185             throw new DateTimeException("Unsupported field: " + field.getName());
 186         }
 187         return field.doGet(this);
 188     }
 189 
 190     //-------------------------------------------------------------------------
 191     @Override
 192     public Temporal adjustInto(Temporal temporal) {
 193         return temporal.with(ERA, getValue());
 194     }
 195 
 196     //-----------------------------------------------------------------------
 197     @Override
 198     public String getText(TextStyle style, Locale locale) {
 199         return new DateTimeFormatterBuilder().appendText(ERA, style).toFormatter(locale).print(this);
 200     }
 201 
 202     //-----------------------------------------------------------------------
 203     private Object writeReplace() {
 204         return new Ser(Ser.THAIBUDDHIST_ERA_TYPE, this);
 205     }
 206 
 207     void writeExternal(DataOutput out) throws IOException {
 208         out.writeByte(this.getValue());
 209     }
 210 
 211     static ThaiBuddhistEra readExternal(DataInput in) throws IOException {
 212         byte eraValue = in.readByte();
 213         return ThaiBuddhistEra.of(eraValue);
 214     }
 215 
 216 }