org.threeten.bp.temporal.JulianFields.scala Maven / Gradle / Ivy
/*
* Copyright (c) 2007-present, 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 org.threeten.bp.temporal
import org.threeten.bp.temporal.ChronoField.EPOCH_DAY
import org.threeten.bp.temporal.ChronoUnit.DAYS
import org.threeten.bp.temporal.ChronoUnit.FOREVER
import java.util.{ Locale, Objects }
import org.threeten.bp.DateTimeException
import org.threeten.bp.chrono.Chronology
import org.threeten.bp.format.ResolverStyle
/**
* A set of date fields that provide access to Julian Days.
*
* The Julian Day is a standard way of expressing date and time commonly used in the scientific
* community. It is expressed as a decimal number of whole days where days start at midday. This
* class represents variations on Julian Days that count whole days from midnight.
*
* Specification for implementors
This is an immutable and thread-safe class.
*/
object JulianFields {
/**
* Julian Day field.
*
* This is an integer-based version of the Julian Day Number. Julian Day is a well-known system
* that represents the count of whole days since day 0, which is defined to be January 1, 4713 BCE
* in the Julian calendar, and -4713-11-24 Gregorian. The field has "JulianDay" as 'name', and
* 'DAYS' as 'baseUnit'. The field always refers to the local date-time, ignoring the offset or
* zone.
*
* For date-times, 'JULIAN_DAY.getFrom()' assumes the same value from midnight until just before
* the next midnight. When 'JULIAN_DAY.adjustInto()' is applied to a date-time, the time of day
* portion remains unaltered. 'JULIAN_DAY.adjustInto()' and 'JULIAN_DAY.getFrom()' only apply to
* {@code Temporal} objects that can be converted into {@link ChronoField#EPOCH_DAY}. A {@link
* DateTimeException} is thrown for any other type of object.
*
* Astronomical and Scientific Notes
The standard astronomical definition uses a fraction
* to indicate the time-of-day, thus 3.25 would represent the time 18:00, since days start at
* midday. This implementation uses an integer and days starting at midnight. The integer value
* for the Julian Day Number is the astronomical Julian Day value at midday of the date in
* question. This amounts to the astronomical Julian Day, rounded to an integer {@code JDN =
* floor(JD + 0.5)}.
*
*
* | ISO date | Julian Day Number | Astronomical Julian Day |
* |:-----------------|------------------:|:------------------------|
* | 1970-01-01T00:00 | 2,440,588 | 2,440,587.5 |
* | 1970-01-01T06:00 | 2,440,588 | 2,440,587.75 |
* | 1970-01-01T12:00 | 2,440,588 | 2,440,588.0 |
* | 1970-01-01T18:00 | 2,440,588 | 2,440,588.25 |
* | 1970-01-02T00:00 | 2,440,589 | 2,440,588.5 |
* | 1970-01-02T06:00 | 2,440,589 | 2,440,588.75 |
* | 1970-01-02T12:00 | 2,440,589 | 2,440,589.0 |
*
*
* Julian Days are sometimes taken to imply Universal Time or UTC, but this implementation always
* uses the Julian Day number for the local date, regardless of the offset or time-zone.
*/
lazy val JULIAN_DAY: TemporalField = Field.JULIAN_DAY
/**
* Modified Julian Day field.
*
* This is an integer-based version of the Modified Julian Day Number. Modified Julian Day (MJD)
* is a well-known system that counts days continuously. It is defined relative to astronomical
* Julian Day as {@code MJD = JD - 2400000.5}. Each Modified Julian Day runs from midnight to
* midnight. The field always refers to the local date-time, ignoring the offset or zone.
*
* For date-times, 'MODIFIED_JULIAN_DAY.getFrom()' assumes the same value from midnight until just
* before the next midnight. When 'MODIFIED_JULIAN_DAY.adjustInto()' is applied to a date-time,
* the time of day portion remains unaltered. 'MODIFIED_JULIAN_DAY.adjustInto()' and
* 'MODIFIED_JULIAN_DAY.getFrom()' only apply to {@code Temporal} objects that can be converted
* into {@link ChronoField#EPOCH_DAY}. A {@link DateTimeException} is thrown for any other type of
* object.
*
* This implementation is an integer version of MJD with the decimal part rounded to floor.
*
* Astronomical and Scientific Notes
* | ISO date | Modified Julian Day | Decimal MJD |
* |:-----------------|:--------------------|------------:|
* | 1970-01-01T00:00 | 40,587 | 40,587.0 |
* | 1970-01-01T06:00 | 40,587 | 40,587.25 |
* | 1970-01-01T12:00 | 40,587 | 40,587.5 |
* | 1970-01-01T18:00 | 40,587 | 40,587.75 |
* | 1970-01-02T00:00 | 40,588 | 40,588.0 |
* | 1970-01-02T06:00 | 40,588 | 40,588.25 |
* | 1970-01-02T12:00 | 40,588 | 40,588.5 |
*
*
* Modified Julian Days are sometimes taken to imply Universal Time or UTC, but this
* implementation always uses the Modified Julian Day for the local date, regardless of the offset
* or time-zone.
*/
lazy val MODIFIED_JULIAN_DAY: TemporalField = Field.MODIFIED_JULIAN_DAY
/**
* Rata Die field.
*
* Rata Die counts whole days continuously starting day 1 at midnight at the beginning of
* 0001-01-01 (ISO). The field always refers to the local date-time, ignoring the offset or zone.
*
* For date-times, 'RATA_DIE.getFrom()' assumes the same value from midnight until just before the
* next midnight. When 'RATA_DIE.adjustInto()' is applied to a date-time, the time of day portion
* remains unaltered. 'MODIFIED_JULIAN_DAY.adjustInto()' and 'RATA_DIE.getFrom()' only apply to
* {@code Temporal} objects that can be converted into {@link ChronoField#EPOCH_DAY}. A {@link
* DateTimeException} is thrown for any other type of object.
*/
lazy val RATA_DIE: TemporalField = Field.RATA_DIE
/** Hidden implementation. */
private object Field {
/** Julian Day field. */
// 719163L + 1721425L = 2440588L
def JULIAN_DAY = new Field("JulianDay", 0, DAYS, FOREVER, 2440588L)
/** Modified Julian Day field. */
// 719163L - 678576L = 40587L
def MODIFIED_JULIAN_DAY = new Field("ModifiedJulianDay", 1, DAYS, FOREVER, 40587L)
/** Rata Die field. */
def RATA_DIE = new Field("RataDie", 2, DAYS, FOREVER, 719163L)
}
// / !!! FIXME: Passing of name to the Enum constructor is not quite right.
// We should have a look at the compiled code to figure out what's happening exactly in the Java version.
private final class Field private (
name: String,
ordinal: Int,
private val baseUnit: TemporalUnit,
private val rangeUnit: TemporalUnit,
private val offset: Long
) extends Enum[Field](name, ordinal)
with TemporalField {
val range: ValueRange = ValueRange.of(-365243219162L + offset, 365241780471L + offset)
def getBaseUnit: TemporalUnit = baseUnit
def getRangeUnit: TemporalUnit = rangeUnit
def isDateBased: Boolean = true
def isTimeBased: Boolean = false
def isSupportedBy(temporal: TemporalAccessor): Boolean = temporal.isSupported(EPOCH_DAY)
def rangeRefinedBy(temporal: TemporalAccessor): ValueRange =
if (!isSupportedBy(temporal))
throw new UnsupportedTemporalTypeException(s"Unsupported field: $this")
else range
def getFrom(temporal: TemporalAccessor): Long = temporal.getLong(EPOCH_DAY) + offset
def adjustInto[R <: Temporal](dateTime: R, newValue: Long): R =
if (!range.isValidValue(newValue))
throw new DateTimeException(s"Invalid value: $name $newValue")
else dateTime.`with`(EPOCH_DAY, Math.subtractExact(newValue, offset)).asInstanceOf[R]
def getDisplayName(locale: Locale): String = {
Objects.requireNonNull(locale, "locale")
toString
}
def resolve(
fieldValues: java.util.Map[TemporalField, java.lang.Long],
partialTemporal: TemporalAccessor,
resolverStyle: ResolverStyle
): TemporalAccessor = {
val value: java.lang.Long = fieldValues.remove(this)
val chrono: Chronology = Chronology.from(partialTemporal)
chrono.dateEpochDay(Math.subtractExact(value, offset))
}
override def toString: String = name
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy