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 tck.java.time.chrono; 58 59 60 import java.time.DateTimeException; 61 import java.time.chrono.Era; 62 63 /** 64 * An era in the Coptic calendar system. 65 * <p> 66 * The Coptic calendar system uses the 'Era of the Martyrs'. 67 * The start of the Coptic epoch {@code 0001-01-01 (Coptic)} is {@code 0284-08-29 (ISO)}. 68 * <p> 69 * <b>Do not use {@code ordinal()} to obtain the numeric representation of {@code CopticEra}. 70 * Use {@code getValue()} instead.</b> 71 * 72 * <h4>Implementation notes</h4> 73 * This is an immutable and thread-safe enum. 74 */ 75 public enum CopticEra implements Era { 76 77 /** 78 * The singleton instance for the era BEFORE_AM, 'Before Era of the Martyrs'. 79 * This has the numeric value of {@code 0}. 80 */ 81 BEFORE_AM, 82 /** 83 * The singleton instance for the era AM, 'Era of the Martyrs'. 84 * This has the numeric value of {@code 1}. 85 */ 86 AM; 87 88 //----------------------------------------------------------------------- 89 /** 90 * Obtains an instance of {@code CopticEra} from an {@code int} value. 91 * <p> 92 * {@code CopticEra} is an enum representing the Coptic eras of BEFORE_AM/AM. 93 * This factory allows the enum to be obtained from the {@code int} value. 94 * 95 * @param era the BEFORE_AM/AM value to represent, from 0 (BEFORE_AM) to 1 (AM) 96 * @return the era singleton, not null 97 * @throws DateTimeException if the value is invalid 98 */ of(int era)99 public static CopticEra of(int era) { 100 switch (era) { 101 case 0: 102 return BEFORE_AM; 103 case 1: 104 return AM; 105 default: 106 throw new DateTimeException("Invalid era: " + era); 107 } 108 } 109 110 //----------------------------------------------------------------------- 111 /** 112 * Gets the numeric era {@code int} value. 113 * <p> 114 * The era BEFORE_AM has the value 0, while the era AM has the value 1. 115 * 116 * @return the era value, from 0 (BEFORE_AM) to 1 (AM) 117 */ getValue()118 public int getValue() { 119 return ordinal(); 120 } 121 122 } 123