jdk/src/share/classes/java/time/chrono/HijrahEra.java
changeset 15658 55b829ca2334
child 16852 60207b2b4b42
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/share/classes/java/time/chrono/HijrahEra.java	Tue Feb 12 09:25:43 2013 -0800
@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *  * Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ *  * Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ *  * Neither the name of JSR-310 nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package java.time.chrono;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+import java.time.DateTimeException;
+
+/**
+ * An era in the Hijrah calendar system.
+ * <p>
+ * The Hijrah calendar system has two eras.
+ * The date {@code 0001-01-01 (Hijrah)} is {@code 622-06-19 (ISO)}.
+ * <p>
+ * <b>Do not use {@code ordinal()} to obtain the numeric representation of {@code HijrahEra}.
+ * Use {@code getValue()} instead.</b>
+ *
+ * <h3>Specification for implementors</h3>
+ * This is an immutable and thread-safe enum.
+ *
+ * @since 1.8
+ */
+enum HijrahEra implements Era {
+
+    /**
+     * The singleton instance for the era before the current one, 'Before Anno Hegirae',
+     * which has the value 0.
+     */
+    BEFORE_AH,
+    /**
+     * The singleton instance for the current era, 'Anno Hegirae', which has the value 1.
+     */
+    AH;
+
+    //-----------------------------------------------------------------------
+    /**
+     * Obtains an instance of {@code HijrahEra} from a value.
+     * <p>
+     * The current era (from ISO date 622-06-19 onwards) has the value 1
+     * The previous era has the value 0.
+     *
+     * @param hijrahEra  the era to represent, from 0 to 1
+     * @return the HijrahEra singleton, never null
+     * @throws DateTimeException if the era is invalid
+     */
+    public static HijrahEra of(int hijrahEra) {
+        switch (hijrahEra) {
+            case 0:
+                return BEFORE_AH;
+            case 1:
+                return AH;
+            default:
+                throw new DateTimeException("HijrahEra not valid");
+        }
+    }
+
+    //-----------------------------------------------------------------------
+    /**
+     * Gets the era numeric value.
+     * <p>
+     * The current era (from ISO date 622-06-19 onwards) has the value 1.
+     * The previous era has the value 0.
+     *
+     * @return the era value, from 0 (BEFORE_AH) to 1 (AH)
+     */
+    @Override
+    public int getValue() {
+        return ordinal();
+    }
+
+    @Override
+    public HijrahChronology getChronology() {
+        return HijrahChronology.INSTANCE;
+    }
+
+    // JDK8 default methods:
+    //-----------------------------------------------------------------------
+    @Override
+    public HijrahDate date(int year, int month, int day) {
+        return (HijrahDate)(getChronology().date(this, year, month, day));
+    }
+
+    @Override
+    public HijrahDate dateYearDay(int year, int dayOfYear) {
+        return (HijrahDate)(getChronology().dateYearDay(this, year, dayOfYear));
+    }
+
+    //-------------------------------------------------------------------------
+    /**
+     * Returns the proleptic year from this era and year of era.
+     *
+     * @param yearOfEra the year of Era
+     * @return the computed prolepticYear
+     */
+    int prolepticYear(int yearOfEra) {
+        return (this == HijrahEra.AH ? yearOfEra : 1 - yearOfEra);
+    }
+
+    //-----------------------------------------------------------------------
+    private Object writeReplace() {
+        return new Ser(Ser.HIJRAH_ERA_TYPE, this);
+    }
+
+    void writeExternal(DataOutput out) throws IOException {
+        out.writeByte(this.getValue());
+    }
+
+    static HijrahEra readExternal(DataInput in) throws IOException {
+        byte eraValue = in.readByte();
+        return HijrahEra.of(eraValue);
+    }
+
+}