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 * 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.temporal; 63 64 import static java.time.temporal.ChronoField.EPOCH_DAY; 65 import static java.time.temporal.ChronoUnit.DAYS; 66 import static java.time.temporal.ChronoUnit.FOREVER; 67 68 import java.time.DateTimeException; 69 import java.time.ZoneId; 70 import java.time.chrono.ChronoLocalDate; 71 import java.time.chrono.Chronology; 72 import java.time.format.ResolverStyle; 73 import java.util.Collections; 74 import java.util.Map; 75 76 /** 77 * A set of date fields that provide access to Julian Days. 78 * <p> 79 * The Julian Day is a standard way of expressing date and time commonly used in the scientific community. 80 * It is expressed as a decimal number of whole days where days start at midday. 81 * This class represents variations on Julian Days that count whole days from midnight. 82 * <p> 83 * The fields are implemented relative to {@link ChronoField#EPOCH_DAY EPOCH_DAY}. 84 * The fields are supported, and can be queried and set if {@code EPOCH_DAY} is available. 85 * The fields work with all chronologies. 86 * 87 * @implSpec 88 * This is an immutable and thread-safe class. 89 * 90 * @since 1.8 91 */ 92 public final class JulianFields { 93 94 /** 95 * The offset from Julian to EPOCH DAY. 96 */ 97 private static final long JULIAN_DAY_OFFSET = 2440588L; 98 99 /** 100 * Julian Day field. 101 * <p> 102 * This is an integer-based version of the Julian Day Number. 103 * Julian Day is a well-known system that represents the count of whole days since day 0, 104 * which is defined to be January 1, 4713 BCE in the Julian calendar, and -4713-11-24 Gregorian. 105 * The field has "JulianDay" as 'name', and 'DAYS' as 'baseUnit'. 106 * The field always refers to the local date-time, ignoring the offset or zone. 107 * <p> 108 * For date-times, 'JULIAN_DAY.getFrom()' assumes the same value from 109 * midnight until just before the next midnight. 110 * When 'JULIAN_DAY.adjustInto()' is applied to a date-time, the time of day portion remains unaltered. 111 * 'JULIAN_DAY.adjustInto()' and 'JULIAN_DAY.getFrom()' only apply to {@code Temporal} objects that 112 * can be converted into {@link ChronoField#EPOCH_DAY}. 113 * An {@link UnsupportedTemporalTypeException} is thrown for any other type of object. 114 * <p> 115 * In the resolving phase of parsing, a date can be created from a Julian Day field. 116 * In {@linkplain ResolverStyle#STRICT strict mode} and {@linkplain ResolverStyle#SMART smart mode} 117 * the Julian Day value is validated against the range of valid values. 118 * In {@linkplain ResolverStyle#LENIENT lenient mode} no validation occurs. 119 * <p> 120 * <h3>Astronomical and Scientific Notes</h3> 121 * The standard astronomical definition uses a fraction to indicate the time-of-day, 122 * thus 3.25 would represent the time 18:00, since days start at midday. 123 * This implementation uses an integer and days starting at midnight. 124 * The integer value for the Julian Day Number is the astronomical Julian Day value at midday 125 * of the date in question. 126 * This amounts to the astronomical Julian Day, rounded to an integer {@code JDN = floor(JD + 0.5)}. 127 * <p> 128 * <pre> 129 * | ISO date | Julian Day Number | Astronomical Julian Day | 130 * | 1970-01-01T00:00 | 2,440,588 | 2,440,587.5 | 131 * | 1970-01-01T06:00 | 2,440,588 | 2,440,587.75 | 132 * | 1970-01-01T12:00 | 2,440,588 | 2,440,588.0 | 133 * | 1970-01-01T18:00 | 2,440,588 | 2,440,588.25 | 134 * | 1970-01-02T00:00 | 2,440,589 | 2,440,588.5 | 135 * | 1970-01-02T06:00 | 2,440,589 | 2,440,588.75 | 136 * | 1970-01-02T12:00 | 2,440,589 | 2,440,589.0 | 137 * </pre> 138 * <p> 139 * Julian Days are sometimes taken to imply Universal Time or UTC, but this 140 * implementation always uses the Julian Day number for the local date, 141 * regardless of the offset or time-zone. 142 */ 143 public static final TemporalField JULIAN_DAY = Field.JULIAN_DAY; 144 145 /** 146 * Modified Julian Day field. 147 * <p> 148 * This is an integer-based version of the Modified Julian Day Number. 149 * Modified Julian Day (MJD) is a well-known system that counts days continuously. 150 * It is defined relative to astronomical Julian Day as {@code MJD = JD - 2400000.5}. 151 * Each Modified Julian Day runs from midnight to midnight. 152 * The field always refers to the local date-time, ignoring the offset or zone. 153 * <p> 154 * For date-times, 'MODIFIED_JULIAN_DAY.getFrom()' assumes the same value from 155 * midnight until just before the next midnight. 156 * When 'MODIFIED_JULIAN_DAY.adjustInto()' is applied to a date-time, the time of day portion remains unaltered. 157 * 'MODIFIED_JULIAN_DAY.adjustInto()' and 'MODIFIED_JULIAN_DAY.getFrom()' only apply to {@code Temporal} objects 158 * that can be converted into {@link ChronoField#EPOCH_DAY}. 159 * An {@link UnsupportedTemporalTypeException} is thrown for any other type of object. 160 * <p> 161 * This implementation is an integer version of MJD with the decimal part rounded to floor. 162 * <p> 163 * In the resolving phase of parsing, a date can be created from a Modified Julian Day field. 164 * In {@linkplain ResolverStyle#STRICT strict mode} and {@linkplain ResolverStyle#SMART smart mode} 165 * the Modified Julian Day value is validated against the range of valid values. 166 * In {@linkplain ResolverStyle#LENIENT lenient mode} no validation occurs. 167 * <p> 168 * <h3>Astronomical and Scientific Notes</h3> 169 * <pre> 170 * | ISO date | Modified Julian Day | Decimal MJD | 171 * | 1970-01-01T00:00 | 40,587 | 40,587.0 | 172 * | 1970-01-01T06:00 | 40,587 | 40,587.25 | 173 * | 1970-01-01T12:00 | 40,587 | 40,587.5 | 174 * | 1970-01-01T18:00 | 40,587 | 40,587.75 | 175 * | 1970-01-02T00:00 | 40,588 | 40,588.0 | 176 * | 1970-01-02T06:00 | 40,588 | 40,588.25 | 177 * | 1970-01-02T12:00 | 40,588 | 40,588.5 | 178 * </pre> 179 * <p> 180 * Modified Julian Days are sometimes taken to imply Universal Time or UTC, but this 181 * implementation always uses the Modified Julian Day for the local date, 182 * regardless of the offset or time-zone. 183 */ 184 public static final TemporalField MODIFIED_JULIAN_DAY = Field.MODIFIED_JULIAN_DAY; 185 186 /** 187 * Rata Die field. 188 * <p> 189 * Rata Die counts whole days continuously starting day 1 at midnight at the beginning of 0001-01-01 (ISO). 190 * The field always refers to the local date-time, ignoring the offset or zone. 191 * <p> 192 * For date-times, 'RATA_DIE.getFrom()' assumes the same value from 193 * midnight until just before the next midnight. 194 * When 'RATA_DIE.adjustInto()' is applied to a date-time, the time of day portion remains unaltered. 195 * 'RATA_DIE.adjustInto()' and 'RATA_DIE.getFrom()' only apply to {@code Temporal} objects 196 * that can be converted into {@link ChronoField#EPOCH_DAY}. 197 * An {@link UnsupportedTemporalTypeException} is thrown for any other type of object. 198 * <p> 199 * In the resolving phase of parsing, a date can be created from a Rata Die field. 200 * In {@linkplain ResolverStyle#STRICT strict mode} and {@linkplain ResolverStyle#SMART smart mode} 201 * the Rata Die value is validated against the range of valid values. 202 * In {@linkplain ResolverStyle#LENIENT lenient mode} no validation occurs. 203 */ 204 public static final TemporalField RATA_DIE = Field.RATA_DIE; 205 206 /** 207 * Restricted constructor. 208 */ 209 private JulianFields() { 210 throw new AssertionError("Not instantiable"); 211 } 212 213 /** 214 * Implementation of JulianFields. Each instance is a singleton. 215 */ 216 private static enum Field implements TemporalField { 217 JULIAN_DAY("JulianDay", DAYS, FOREVER, JULIAN_DAY_OFFSET), 218 MODIFIED_JULIAN_DAY("ModifiedJulianDay", DAYS, FOREVER, 40587L), 219 RATA_DIE("RataDie", DAYS, FOREVER, 719163L); 220 221 private static final long serialVersionUID = -7501623920830201812L; 222 223 private final transient String name; 224 private final transient TemporalUnit baseUnit; 225 private final transient TemporalUnit rangeUnit; 226 private final transient ValueRange range; 227 private final transient long offset; 228 229 private Field(String name, TemporalUnit baseUnit, TemporalUnit rangeUnit, long offset) { 230 this.name = name; 231 this.baseUnit = baseUnit; 232 this.rangeUnit = rangeUnit; 233 this.range = ValueRange.of(-365243219162L + offset, 365241780471L + offset); 234 this.offset = offset; 235 } 236 237 //----------------------------------------------------------------------- 238 @Override 239 public TemporalUnit getBaseUnit() { 240 return baseUnit; 241 } 242 243 @Override 244 public TemporalUnit getRangeUnit() { 245 return rangeUnit; 246 } 247 248 @Override 249 public boolean isDateBased() { 250 return true; 251 } 252 253 @Override 254 public boolean isTimeBased() { 255 return false; 256 } 257 258 @Override 259 public ValueRange range() { 260 return range; 261 } 262 263 //----------------------------------------------------------------------- 264 @Override 265 public boolean isSupportedBy(TemporalAccessor temporal) { 266 return temporal.isSupported(EPOCH_DAY); 267 } 268 269 @Override 270 public ValueRange rangeRefinedBy(TemporalAccessor temporal) { 271 if (isSupportedBy(temporal) == false) { 272 throw new DateTimeException("Unsupported field: " + this); 273 } 274 return range(); 275 } 276 277 @Override 278 public long getFrom(TemporalAccessor temporal) { 279 return temporal.getLong(EPOCH_DAY) + offset; 280 } 281 282 @SuppressWarnings("unchecked") 283 @Override 284 public <R extends Temporal> R adjustInto(R temporal, long newValue) { 285 if (range().isValidValue(newValue) == false) { 286 throw new DateTimeException("Invalid value: " + name + " " + newValue); 287 } 288 return (R) temporal.with(EPOCH_DAY, Math.subtractExact(newValue, offset)); 289 } 290 291 //----------------------------------------------------------------------- 292 @Override 293 public ChronoLocalDate resolve( 294 Map<TemporalField, Long> fieldValues, Chronology chronology, ZoneId zone, ResolverStyle resolverStyle) { 295 long value = fieldValues.remove(this); 296 if (resolverStyle == ResolverStyle.LENIENT) { 297 return chronology.dateEpochDay(Math.subtractExact(value, offset)); 298 } 299 range().checkValidValue(value, this); 300 return chronology.dateEpochDay(value - offset); 301 } 302 303 //----------------------------------------------------------------------- 304 @Override 305 public String toString() { 306 return name; 307 } 308 } 309 }