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