1 /*
2 * Copyright (c) 2012, 2017, 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 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file:
31 *
32 * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos
33 *
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions are met:
38 *
39 * * Redistributions of source code must retain the above copyright notice,
40 * this list of conditions and the following disclaimer.
41 *
42 * * Redistributions in binary form must reproduce the above copyright notice,
43 * this list of conditions and the following disclaimer in the documentation
44 * and/or other materials provided with the distribution.
45 *
46 * * Neither the name of JSR-310 nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
54 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 */
62 package java.time.chrono;
63
64 import static java.time.temporal.ChronoField.ERA;
65
66 import java.time.DateTimeException;
67 import java.time.format.DateTimeFormatterBuilder;
68 import java.time.format.TextStyle;
69 import java.time.temporal.ChronoField;
70 import java.time.temporal.TemporalField;
71 import java.time.temporal.UnsupportedTemporalTypeException;
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 only one era covering the
79 * proleptic years greater than zero.
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 * @implSpec
85 * This is an immutable and thread-safe enum.
86 *
87 * @since 1.8
88 */
89 public enum HijrahEra implements Era {
90
91 /**
92 * The singleton instance for the current era, 'Anno Hegirae',
93 * which has the numeric value 1.
94 */
95 AH;
96
97 //-----------------------------------------------------------------------
98 /**
99 * Obtains an instance of {@code HijrahEra} from an {@code int} value.
100 * <p>
101 * The current era, which is the only accepted value, has the value 1
102 *
103 * @param hijrahEra the era to represent, only 1 supported
104 * @return the HijrahEra.AH singleton, not null
105 * @throws DateTimeException if the value is invalid
106 */
107 public static HijrahEra of(int hijrahEra) {
108 if (hijrahEra == 1 ) {
109 return AH;
110 } else {
111 throw new DateTimeException("Invalid era: " + hijrahEra);
112 }
113 }
114
115 //-----------------------------------------------------------------------
116 /**
117 * Gets the numeric era {@code int} value.
118 * <p>
119 * The era AH has the value 1.
120 *
121 * @return the era value, 1 (AH)
122 */
123 @Override
124 public int getValue() {
125 return 1;
126 }
127
128 //-----------------------------------------------------------------------
129 /**
130 * Gets the range of valid values for the specified field.
131 * <p>
132 * The range object expresses the minimum and maximum valid values for a field.
133 * This era is used to enhance the accuracy of the returned range.
134 * If it is not possible to return the range, because the field is not supported
135 * or for some other reason, an exception is thrown.
136 * <p>
137 * If the field is a {@link ChronoField} then the query is implemented here.
138 * The {@code ERA} field returns the range.
139 * All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
140 * <p>
141 * If the field is not a {@code ChronoField}, then the result of this method
142 * is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)}
143 * passing {@code this} as the argument.
144 * Whether the range can be obtained is determined by the field.
145 * <p>
146 * The {@code ERA} field returns a range for the one valid Hijrah era.
147 *
148 * @param field the field to query the range for, not null
149 * @return the range of valid values for the field, not null
150 * @throws DateTimeException if the range for the field cannot be obtained
151 * @throws UnsupportedTemporalTypeException if the unit is not supported
152 */
153 @Override // override as super would return range from 0 to 1
154 public ValueRange range(TemporalField field) {
155 if (field == ERA) {
156 return ValueRange.of(1, 1);
157 }
158 return Era.super.range(field);
159 }
160
161 /**
162 * {@inheritDoc}
163 *
164 * @param style {@inheritDoc}
165 * @param locale {@inheritDoc}
166 */
167 @Override
168 public String getDisplayName(TextStyle style, Locale locale) {
169 return new DateTimeFormatterBuilder()
170 .appendText(ERA, style)
171 .toFormatter(locale)
172 .withChronology(HijrahChronology.INSTANCE)
173 .format(HijrahDate.now());
174 }
175 }
176