< prev index next >

src/java.base/share/classes/java/time/chrono/HijrahEra.java

Print this page
rev 17640 : [mq]: 8171049
   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


  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.temporal.ChronoField;
  68 import java.time.temporal.TemporalField;
  69 import java.time.temporal.UnsupportedTemporalTypeException;
  70 import java.time.temporal.ValueRange;

  71 
  72 /**
  73  * An era in the Hijrah calendar system.
  74  * <p>
  75  * The Hijrah calendar system has only one era covering the
  76  * proleptic years greater than zero.
  77  * <p>
  78  * <b>Do not use {@code ordinal()} to obtain the numeric representation of {@code HijrahEra}.
  79  * Use {@code getValue()} instead.</b>
  80  *
  81  * @implSpec
  82  * This is an immutable and thread-safe enum.
  83  *
  84  * @since 1.8
  85  */
  86 public enum HijrahEra implements Era {
  87 
  88     /**
  89      * The singleton instance for the current era, 'Anno Hegirae',
  90      * which has the numeric value 1.


 138      * If the field is not a {@code ChronoField}, then the result of this method
 139      * is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)}
 140      * passing {@code this} as the argument.
 141      * Whether the range can be obtained is determined by the field.
 142      * <p>
 143      * The {@code ERA} field returns a range for the one valid Hijrah era.
 144      *
 145      * @param field  the field to query the range for, not null
 146      * @return the range of valid values for the field, not null
 147      * @throws DateTimeException if the range for the field cannot be obtained
 148      * @throws UnsupportedTemporalTypeException if the unit is not supported
 149      */
 150     @Override  // override as super would return range from 0 to 1
 151     public ValueRange range(TemporalField field) {
 152         if (field == ERA) {
 153             return ValueRange.of(1, 1);
 154         }
 155         return Era.super.range(field);
 156     }
 157 














 158 }
   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


  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.


 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 }
< prev index next >