public final class Instant extends java.lang.Object implements Temporal, TemporalAdjuster, java.lang.Comparable<Instant>, java.io.Serializable
This class models a single instantaneous point on the time-line. This might be used to record event time-stamps in the application.
For practicality, the instant is stored with some constraints.
The measurable time-line is restricted to the number of seconds that can be held
in a long
. This is greater than the current estimated age of the universe.
The instant is stored to nanosecond resolution.
The range of an instant requires the storage of a number larger than a long
.
To achieve this, the class stores a long
representing epoch-seconds and an
int
representing nanosecond-of-second, which will always be between 0 and 999,999,999.
The epoch-seconds are measured from the standard Java epoch of 1970-01-01T00:00:00Z
where instants after the epoch have positive values, and earlier instants have negative values.
For both the epoch-second and nanosecond parts, a larger value is always later on the time-line
than a smaller value.
The length of the solar day is the standard way that humans measure time. This has traditionally been subdivided into 24 hours of 60 minutes of 60 seconds, forming a 86400 second day.
Modern timekeeping is based on atomic clocks which precisely define an SI second relative to the transitions of a Caesium atom. The length of an SI second was defined to be very close to the 86400th fraction of a day.
Unfortunately, as the Earth rotates the length of the day varies. In addition, over time the average length of the day is getting longer as the Earth slows. As a result, the length of a solar day in 2012 is slightly longer than 86400 SI seconds. The actual length of any given day and the amount by which the Earth is slowing are not predictable and can only be determined by measurement. The UT1 time-scale captures the accurate length of day, but is only available some time after the day has completed.
The UTC time-scale is a standard approach to bundle up all the additional fractions of a second from UT1 into whole seconds, known as leap-seconds. A leap-second may be added or removed depending on the Earth's rotational changes. As such, UTC permits a day to have 86399 SI seconds or 86401 SI seconds where necessary in order to keep the day aligned with the Sun.
The modern UTC time-scale was introduced in 1972, introducing the concept of whole leap-seconds. Between 1958 and 1972, the definition of UTC was complex, with minor sub-second leaps and alterations to the length of the notional second. As of 2012, discussions are underway to change the definition of UTC again, with the potential to remove leap seconds or introduce other changes.
Given the complexity of accurate timekeeping described above, this Java API defines its own time-scale with a simplification. The Java time-scale is defined as follows:
Agreed international civil time is the base time-scale agreed by international convention, which in 2012 is UTC (with leap-seconds).
In 2012, the definition of the Java time-scale is the same as UTC for all days except those where a leap-second occurs. On days where a leap-second does occur, the time-scale effectively eliminates the leap-second, maintaining the fiction of 86400 seconds in the day.
The main benefit of always dividing the day into 86400 subdivisions is that it matches the expectations of most users of the API. The alternative is to force every user to understand what a leap second is and to force them to have special logic to handle them. Most applications do not have access to a clock that is accurate enough to record leap-seconds. Most applications also do not have a problem with a second being a very small amount longer or shorter than a real SI second during a leap-second.
If an application does have access to an accurate clock that reports leap-seconds, then the recommended technique to implement the Java time-scale is to use the UTC-SLS convention. UTC-SLS effectively smoothes the leap-second over the last 1000 seconds of the day, making each of the last 1000 "seconds" 1/1000th longer or shorter than a real SI second.
One final problem is the definition of the agreed international civil time before the
introduction of modern UTC in 1972. This includes the Java epoch of 1970-01-01
.
It is intended that instants before 1972 be interpreted based on the solar day divided
into 86400 subdivisions.
The Java time-scale is used for all date-time classes.
This includes Instant
, LocalDate
, LocalTime
, OffsetDateTime
,
ZonedDateTime
and Duration
.
Modifier and Type | Field and Description |
---|---|
static Instant |
EPOCH
Constant for the 1970-01-01T00:00:00Z epoch instant.
|
static Instant |
MAX
The minimum supported
Instant , '-1000000000-01-01T00:00Z'. |
static Instant |
MIN
The minimum supported
Instant , '-1000000000-01-01T00:00Z'. |
Modifier and Type | Method and Description |
---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have this instant.
|
int |
compareTo(Instant otherInstant)
Compares this instant to the specified instant.
|
boolean |
equals(java.lang.Object otherInstant)
Checks if this instant is equal to the specified instant.
|
static Instant |
from(TemporalAccessor temporal)
Obtains an instance of
Instant from a temporal object. |
int |
get(TemporalField field)
Gets the value of the specified field from this instant as an
int . |
long |
getEpochSecond()
Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z.
|
long |
getLong(TemporalField field)
Gets the value of the specified field from this instant as a
long . |
int |
getNano()
Gets the number of nanoseconds, later along the time-line, from the start
of the second.
|
int |
hashCode()
Returns a hash code for this instant.
|
boolean |
isAfter(Instant otherInstant)
Checks if this instant is after the specified instant.
|
boolean |
isBefore(Instant otherInstant)
Checks if this instant is before the specified instant.
|
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
Instant |
minus(long amountToSubtract,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period subtracted.
|
Instant |
minus(TemporalSubtractor subtractor)
Returns an object of the same type as this object with an amount subtracted.
|
Instant |
minusMillis(long millisToSubtract)
Returns a copy of this instant with the specified duration in milliseconds subtracted.
|
Instant |
minusNanos(long nanosToSubtract)
Returns a copy of this instant with the specified duration in nanoseconds subtracted.
|
Instant |
minusSeconds(long secondsToSubtract)
Returns a copy of this instant with the specified duration in seconds subtracted.
|
static Instant |
now()
Obtains the current instant from the system clock.
|
static Instant |
now(Clock clock)
Obtains the current instant from the specified clock.
|
static Instant |
ofEpochMilli(long epochMilli)
Obtains an instance of
Instant using milliseconds from the
epoch of 1970-01-01T00:00:00Z. |
static Instant |
ofEpochSecond(long epochSecond)
Obtains an instance of
Instant using seconds from the
epoch of 1970-01-01T00:00:00Z. |
static Instant |
ofEpochSecond(long epochSecond,
long nanoAdjustment)
Obtains an instance of
Instant using seconds from the
epoch of 1970-01-01T00:00:00Z and nanosecond fraction of second. |
static Instant |
parse(java.lang.CharSequence text)
Obtains an instance of
Instant from a text string such as
2007-12-03T10:15:30:00 . |
long |
periodUntil(Temporal endInstant,
TemporalUnit unit)
Calculates the period between this instant and another instant in
terms of the specified unit.
|
Instant |
plus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period added.
|
Instant |
plus(TemporalAdder adder)
Returns an object of the same type as this object with an amount added.
|
Instant |
plusMillis(long millisToAdd)
Returns a copy of this instant with the specified duration in milliseconds added.
|
Instant |
plusNanos(long nanosToAdd)
Returns a copy of this instant with the specified duration in nanoseconds added.
|
Instant |
plusSeconds(long secondsToAdd)
Returns a copy of this instant with the specified duration in seconds added.
|
<R> R |
query(TemporalQuery<R> query)
Queries this instant using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
long |
toEpochMilli()
Converts this instant to the number of milliseconds from the epoch
of 1970-01-01T00:00:00Z.
|
java.lang.String |
toString()
A string representation of this instant using ISO-8601 representation.
|
Instant |
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this instant.
|
Instant |
with(TemporalField field,
long newValue)
Returns a copy of this instant with the specified field set to a new value.
|
public static final Instant EPOCH
public static final Instant MIN
Instant
, '-1000000000-01-01T00:00Z'.
This could be used by an application as a "far past" instant.
This is one year earlier than the minimum LocalDateTime
.
This provides sufficient values to handle the range of ZoneOffset
which affect the instant in addition to the local date-time.
The value is also chosen such that the value of the year fits in
an int
.
public static final Instant MAX
Instant
, '-1000000000-01-01T00:00Z'.
This could be used by an application as a "far future" instant.
This is one year later than the maximum LocalDateTime
.
This provides sufficient values to handle the range of ZoneOffset
which affect the instant in addition to the local date-time.
The value is also chosen such that the value of the year fits in
an int
.
public static Instant now()
This will query the system UTC clock
to
obtain the current instant.
Using this method will prevent the ability to use an alternate time-source for testing because the clock is effectively hard-coded.
public static Instant now(Clock clock)
This will query the specified clock to obtain the current time.
Using this method allows the use of an alternate clock for testing.
The alternate clock may be introduced using dependency injection
.
clock
- the clock to use, not nullpublic static Instant ofEpochSecond(long epochSecond)
Instant
using seconds from the
epoch of 1970-01-01T00:00:00Z.
The nanosecond field is set to zero.
epochSecond
- the number of seconds from 1970-01-01T00:00:00ZDateTimeException
- if the instant exceeds the maximum or minimum instantpublic static Instant ofEpochSecond(long epochSecond, long nanoAdjustment)
Instant
using seconds from the
epoch of 1970-01-01T00:00:00Z and nanosecond fraction of second.
This method allows an arbitrary number of nanoseconds to be passed in. The factory will alter the values of the second and nanosecond in order to ensure that the stored nanosecond is in the range 0 to 999,999,999. For example, the following will result in the exactly the same instant:
Instant.ofSeconds(3, 1); Instant.ofSeconds(4, -999_999_999); Instant.ofSeconds(2, 1000_000_001);
epochSecond
- the number of seconds from 1970-01-01T00:00:00ZnanoAdjustment
- the nanosecond adjustment to the number of seconds, positive or negativeDateTimeException
- if the instant exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic static Instant ofEpochMilli(long epochMilli)
Instant
using milliseconds from the
epoch of 1970-01-01T00:00:00Z.
The seconds and nanoseconds are extracted from the specified milliseconds.
epochMilli
- the number of milliseconds from 1970-01-01T00:00:00ZDateTimeException
- if the instant exceeds the maximum or minimum instantpublic static Instant from(TemporalAccessor temporal)
Instant
from a temporal object.
A TemporalAccessor
represents some form of date and time information.
This factory converts the arbitrary temporal object to an instance of Instant
.
The conversion extracts the INSTANT_SECONDS
and NANO_OF_SECOND
fields.
This method matches the signature of the functional interface TemporalQuery
allowing it to be used as a query via method reference, Instant::from
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to an Instant
public static Instant parse(java.lang.CharSequence text)
Instant
from a text string such as
2007-12-03T10:15:30:00
.
The string must represent a valid instant in UTC and is parsed using
DateTimeFormatters.isoInstant()
.
text
- the text to parse, not nullDateTimeParseException
- if the text cannot be parsedpublic boolean isSupported(TemporalField field)
This checks if this instant can be queried for the specified field.
If false, then calling the range
and
get
methods will throw an exception.
If the field is a ChronoField
then the query is implemented here.
The supported fields are:
NANO_OF_SECOND
MICRO_OF_SECOND
MILLI_OF_SECOND
INSTANT_SECONDS
ChronoField
instances will return false.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doIsSupported(TemporalAccessor)
passing this
as the argument.
Whether the field is supported is determined by the field.
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic ValueRange range(TemporalField field)
The range object expresses the minimum and maximum valid values for a field. This instant is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return
appropriate range instances.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doRange(TemporalAccessor)
passing this
as the argument.
Whether the range can be obtained is determined by the field.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedpublic int get(TemporalField field)
int
.
This queries this instant for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return valid
values based on this date-time, except INSTANT_SECONDS
which is too
large to fit in an int
and throws a DateTimeException
.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic long getLong(TemporalField field)
long
.
This queries this instant for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return valid
values based on this date-time.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic long getEpochSecond()
The epoch second count is a simple incrementing count of seconds where
second 0 is 1970-01-01T00:00:00Z.
The nanosecond part of the day is returned by getNanosOfSecond
.
public int getNano()
The nanosecond-of-second value measures the total number of nanoseconds from
the second returned by getEpochSecond
.
public Instant with(TemporalAdjuster adjuster)
This returns a new Instant
, based on this one, with the date adjusted.
The adjustment takes place using the specified adjuster strategy object.
Read the documentation of the adjuster to understand what adjustment will be made.
The result of this method is obtained by invoking the
TemporalAdjuster.adjustInto(Temporal)
method on the
specified adjuster passing this
as the argument.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
adjuster
- the adjuster to use, not nullInstant
based on this
with the adjustment made, not nullDateTimeException
- if the adjustment cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic Instant with(TemporalField field, long newValue)
This returns a new Instant
, based on this one, with the value
for the specified field changed.
If it is not possible to set the value, because the field is not supported or for
some other reason, an exception is thrown.
If the field is a ChronoField
then the adjustment is implemented here.
The supported fields behave as follows:
NANO_OF_SECOND
-
Returns an Instant
with the specified nano-of-second.
The epoch-second will be unchanged.
MICRO_OF_SECOND
-
Returns an Instant
with the nano-of-second replaced by the specified
micro-of-second multiplied by 1,000. The epoch-second will be unchanged.
MILLI_OF_SECOND
-
Returns an Instant
with the nano-of-second replaced by the specified
milli-of-second multiplied by 1,000,000. The epoch-second will be unchanged.
INSTANT_SECONDS
-
Returns an Instant
with the specified epoch-second.
The nano-of-second will be unchanged.
In all cases, if the new value is outside the valid range of values for the field
then a DateTimeException
will be thrown.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doWith(Temporal, long)
passing this
as the argument. In this case, the field determines
whether and how to adjust the instant.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultInstant
based on this
with the specified field set, not nullDateTimeException
- if the field cannot be setjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant plus(TemporalAdder adder)
This adjusts this temporal, adding according to the rules of the specified adder.
The adder is typically a Period
but may be any other type implementing
the TemporalAdder
interface, such as Duration
.
Some example code indicating how and why this method is used:
date = date.plus(period); // add a Period instance date = date.plus(duration); // add a Duration instance date = date.plus(MONTHS.between(start, end)); // static import of MONTHS field date = date.plus(workingDays(6)); // example user-written workingDays method
Note that calling plus
followed by minus
is not guaranteed to
return the same date-time.
The default implementation must behave equivalent to this code:
return adder.addTo(this);
plus
in interface Temporal
adder
- the adder to use, not nullDateTimeException
- if the addition cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic Instant plus(long amountToAdd, TemporalUnit unit)
This method returns a new object based on this one with the specified period added.
For example, on a LocalDate
, this could be used to add a number of years, months or days.
The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime
,
then the permitted units must include the boundary unit, but no multiples of the boundary unit.
For example, LocalTime
must accept DAYS
but not WEEKS
or MONTHS
.
ChronoUnit
.
If the unit is supported, then the addition must be performed.
If unsupported, then a DateTimeException
must be thrown.
If the unit is not a ChronoUnit
, then the result of this method
is obtained by invoking TemporalUnit.doPlus(Temporal, long)
passing this
as the first argument.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
plus
in interface Temporal
amountToAdd
- the amount of the specified unit to add, may be negativeunit
- the unit of the period to add, not nullDateTimeException
- if the unit cannot be addedjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant plusSeconds(long secondsToAdd)
This instance is immutable and unaffected by this method call.
secondsToAdd
- the seconds to add, positive or negativeInstant
based on this instant with the specified seconds added, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant plusMillis(long millisToAdd)
This instance is immutable and unaffected by this method call.
millisToAdd
- the milliseconds to add, positive or negativeInstant
based on this instant with the specified milliseconds added, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant plusNanos(long nanosToAdd)
This instance is immutable and unaffected by this method call.
nanosToAdd
- the nanoseconds to add, positive or negativeInstant
based on this instant with the specified nanoseconds added, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant minus(TemporalSubtractor subtractor)
This adjusts this temporal, subtracting according to the rules of the specified subtractor.
The subtractor is typically a Period
but may be any other type implementing
the TemporalSubtractor
interface, such as Duration
.
Some example code indicating how and why this method is used:
date = date.minus(period); // subtract a Period instance date = date.minus(duration); // subtract a Duration instance date = date.minus(MONTHS.between(start, end)); // static import of MONTHS field date = date.minus(workingDays(6)); // example user-written workingDays method
Note that calling plus
followed by minus
is not guaranteed to
return the same date-time.
The default implementation must behave equivalent to this code:
return subtractor.subtractFrom(this);
minus
in interface Temporal
subtractor
- the subtractor to use, not nullDateTimeException
- if the subtraction cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic Instant minus(long amountToSubtract, TemporalUnit unit)
This method returns a new object based on this one with the specified period subtracted.
For example, on a LocalDate
, this could be used to subtract a number of years, months or days.
The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime
,
then the permitted units must include the boundary unit, but no multiples of the boundary unit.
For example, LocalTime
must accept DAYS
but not WEEKS
or MONTHS
.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit));
minus
in interface Temporal
amountToSubtract
- the amount of the specified unit to subtract, may be negativeunit
- the unit of the period to subtract, not nullDateTimeException
- if the unit cannot be subtractedjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant minusSeconds(long secondsToSubtract)
This instance is immutable and unaffected by this method call.
secondsToSubtract
- the seconds to subtract, positive or negativeInstant
based on this instant with the specified seconds subtracted, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant minusMillis(long millisToSubtract)
This instance is immutable and unaffected by this method call.
millisToSubtract
- the milliseconds to subtract, positive or negativeInstant
based on this instant with the specified milliseconds subtracted, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic Instant minusNanos(long nanosToSubtract)
This instance is immutable and unaffected by this method call.
nanosToSubtract
- the nanoseconds to subtract, positive or negativeInstant
based on this instant with the specified nanoseconds subtracted, not nullDateTimeException
- if the result exceeds the maximum or minimum instantjava.lang.ArithmeticException
- if numeric overflow occurspublic <R> R query(TemporalQuery<R> query)
This queries this instant using the specified query strategy object.
The TemporalQuery
object defines the logic to be used to
obtain the result. Read the documentation of the query to understand
what the result of this method will be.
The result of this method is obtained by invoking the
TemporalQuery.queryFrom(TemporalAccessor)
method on the
specified query passing this
as the argument.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)java.lang.ArithmeticException
- if numeric overflow occurs (defined by the query)public Temporal adjustInto(Temporal temporal)
This returns a temporal object of the same observable type as the input with the instant changed to be the same as this.
The adjustment is equivalent to using Temporal.with(TemporalField, long)
twice, passing ChronoField.INSTANT_SECONDS
and
ChronoField.NANO_OF_SECOND
as the fields.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.with(TemporalAdjuster)
:
// these two lines are equivalent, but the second approach is recommended temporal = thisInstant.adjustInto(temporal); temporal = temporal.with(thisInstant);
This instance is immutable and unaffected by this method call.
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentjava.lang.ArithmeticException
- if numeric overflow occurspublic long periodUntil(Temporal endInstant, TemporalUnit unit)
This calculates the period between two instants in terms of a single unit.
The start and end points are this
and the specified instant.
The result will be negative if the end is before the start.
The calculation returns a whole number, representing the number of
complete units between the two instants.
The Temporal
passed to this method must be an Instant
.
For example, the period in days between two dates can be calculated
using startInstant.periodUntil(endInstant, SECONDS)
.
This method operates in association with TemporalUnit.between(R, R)
.
The result of this method is a long
representing the amount of
the specified unit. By contrast, the result of between
is an
object that can be used directly in addition/subtraction:
long period = start.periodUntil(end, SECONDS); // this method dateTime.plus(SECONDS.between(start, end)); // use in plus/minus
The calculation is implemented in this method for ChronoUnit
.
The units NANOS
, MICROS
, MILLIS
, SECONDS
,
MINUTES
, HOURS
, HALF_DAYS
and DAYS
are supported. Other ChronoUnit
values will throw an exception.
If the unit is not a ChronoUnit
, then the result of this method
is obtained by invoking TemporalUnit.between(Temporal, Temporal)
passing this
as the first argument and the input temporal as
the second argument.
This instance is immutable and unaffected by this method call.
periodUntil
in interface Temporal
endInstant
- the end date, which must be a LocalDate
, not nullunit
- the unit to measure the period in, not nullDateTimeException
- if the period cannot be calculatedjava.lang.ArithmeticException
- if numeric overflow occurspublic long toEpochMilli()
If this instant represents a point on the time-line too far in the future
or past to fit in a long
milliseconds, then an exception is thrown.
If this instant has greater than millisecond precision, then the conversion will drop any excess precision information as though the amount in nanoseconds was subject to integer division by one million.
java.lang.ArithmeticException
- if numeric overflow occurspublic int compareTo(Instant otherInstant)
The comparison is based on the time-line position of the instants.
It is "consistent with equals", as defined by Comparable
.
compareTo
in interface java.lang.Comparable<Instant>
otherInstant
- the other instant to compare to, not nulljava.lang.NullPointerException
- if otherInstant is nullpublic boolean isAfter(Instant otherInstant)
The comparison is based on the time-line position of the instants.
otherInstant
- the other instant to compare to, not nulljava.lang.NullPointerException
- if otherInstant is nullpublic boolean isBefore(Instant otherInstant)
The comparison is based on the time-line position of the instants.
otherInstant
- the other instant to compare to, not nulljava.lang.NullPointerException
- if otherInstant is nullpublic boolean equals(java.lang.Object otherInstant)
The comparison is based on the time-line position of the instants.
equals
in class java.lang.Object
otherInstant
- the other instant, null returns falseObject.hashCode()
,
HashMap
public int hashCode()
hashCode
in class java.lang.Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public java.lang.String toString()
The format used is the same as DateTimeFormatters.isoInstant()
.
toString
in class java.lang.Object