Instant

adjustInto

fun adjustInto(temporal: Temporal!): Temporal!

Adjusts the specified temporal object to have this instant.

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.

atOffset

fun atOffset(offset: ZoneOffset!): OffsetDateTime!

Combines this instant with an offset to create an OffsetDateTime.

This returns an OffsetDateTime formed from this instant at the specified offset from UTC/Greenwich. An exception will be thrown if the instant is too large to fit into an offset date-time.

This method is equivalent to OffsetDateTime.ofInstant(this, offset).

atZone

fun atZone(zone: ZoneId!): ZonedDateTime!

Combines this instant with a time-zone to create a ZonedDateTime.

This returns an ZonedDateTime formed from this instant at the specified time-zone. An exception will be thrown if the instant is too large to fit into a zoned date-time.

This method is equivalent to ZonedDateTime.ofInstant(this, zone).

compareTo

fun compareTo(other: Instant!): Int

Compares this instant to the specified instant.

The comparison is based on the time-line position of the instants. It is "consistent with equals", as defined by Comparable.

equals

fun equals(other: Any?): Boolean

Checks if this instant is equal to the specified instant.

The comparison is based on the time-line position of the instants.

from

static fun from(temporal: TemporalAccessor!): Instant!

Obtains an instance of Instant from a temporal object.

This obtains an instant based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts 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.

get

fun get(field: TemporalField!): Int

Gets the value of the specified field from this instant as an int.

This queries this instant for the value of 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 an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getEpochSecond

fun getEpochSecond(): Long

Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z.

The epoch second count is a simple incrementing count of seconds where second 0 is 1970-01-01T00:00:00Z. The nanosecond part is returned by getNano.

getLong

fun getLong(field: TemporalField!): Long

Gets the value of the specified field from this instant as a long.

This queries this instant for the value of 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 an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getNano

fun getNano(): Int

Gets the number of nanoseconds, later along the time-line, from the start of the second.

The nanosecond-of-second value measures the total number of nanoseconds from the second returned by getEpochSecond.

hashCode

fun hashCode(): Int

Returns a hash code for this instant.

isAfter

fun isAfter(otherInstant: Instant!): Boolean

Checks if this instant is after the specified instant.

The comparison is based on the time-line position of the instants.

isBefore

fun isBefore(otherInstant: Instant!): Boolean

Checks if this instant is before the specified instant.

The comparison is based on the time-line position of the instants.

isSupported

fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if this instant can be queried for the specified field. If false, then calling the range, get and with(java.time.temporal.TemporalField,long) 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

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

isSupported

fun isSupported(unit: TemporalUnit!): Boolean

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the plus(long,java.time.temporal.TemporalUnit) and minus methods will throw an exception.

If the unit is a ChronoUnit then the query is implemented here. The supported units are:

• NANOS
• MICROS
• MILLIS
• SECONDS
• MINUTES
• HOURS
• HALF_DAYS
• DAYS

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument. Whether the unit is supported is determined by the unit.

minus

fun minus(amountToSubtract: TemporalAmount!): Instant!

Returns a copy of this instant with the specified amount subtracted.

This returns an Instant, based on this one, with the specified amount subtracted. The amount is typically Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long,java.time.temporal.TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully subtracted.

This instance is immutable and unaffected by this method call.

minus

fun minus(
    amountToSubtract: Long, 
    unit: TemporalUnit!
): Instant!

Returns a copy of this instant with the specified amount subtracted.

This returns an Instant, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.

This method is equivalent to plus(long,java.time.temporal.TemporalUnit) with the amount negated. See that method for a full description of how addition, and thus subtraction, works.

This instance is immutable and unaffected by this method call.

minusMillis

fun minusMillis(millisToSubtract: Long): Instant!

Returns a copy of this instant with the specified duration in milliseconds subtracted.

This instance is immutable and unaffected by this method call.

minusNanos

fun minusNanos(nanosToSubtract: Long): Instant!

Returns a copy of this instant with the specified duration in nanoseconds subtracted.

This instance is immutable and unaffected by this method call.

minusSeconds

fun minusSeconds(secondsToSubtract: Long): Instant!

Returns a copy of this instant with the specified duration in seconds subtracted.

This instance is immutable and unaffected by this method call.

now

static fun now(): Instant!

Obtains the current instant from the system clock.

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.

now

static fun now(clock: Clock!): Instant!

Obtains the current instant from the specified 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.

ofEpochMilli

static fun ofEpochMilli(epochMilli: Long): Instant!

Obtains an instance of Instant using milliseconds from the epoch of 1970-01-01T00:00:00Z.

The seconds and nanoseconds are extracted from the specified milliseconds.

ofEpochSecond

static fun ofEpochSecond(epochSecond: Long): Instant!

Obtains an instance of Instant using seconds from the epoch of 1970-01-01T00:00:00Z.

The nanosecond field is set to zero.

ofEpochSecond

static fun ofEpochSecond(
    epochSecond: Long, 
    nanoAdjustment: Long
): Instant!

Obtains an instance of 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 exactly the same instant:

Instant.ofEpochSecond(3, 1);
   Instant.ofEpochSecond(4, -999_999_999);
   Instant.ofEpochSecond(2, 1000_000_001);
  

parse

static fun parse(text: CharSequence!): Instant!

Obtains an instance of Instant from a text string such as 2007-12-03T10:15:30.00Z.

The string must represent a valid instant in UTC and is parsed using DateTimeFormatter#ISO_INSTANT.

plus

fun plus(amountToAdd: TemporalAmount!): Instant!

Returns a copy of this instant with the specified amount added.

This returns an Instant, based on this one, with the specified amount added. The amount is typically Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long,java.time.temporal.TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully added.

This instance is immutable and unaffected by this method call.

plus

fun plus(
    amountToAdd: Long, 
    unit: TemporalUnit!
): Instant!

Returns a copy of this instant with the specified amount added.

This returns an Instant, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.

If the field is a ChronoUnit then the addition is implemented here. The supported fields behave as follows:

• NANOS - Returns an Instant with the specified number of nanoseconds added. This is equivalent to plusNanos(long).
• MICROS - Returns an Instant with the specified number of microseconds added. This is equivalent to plusNanos(long) with the amount multiplied by 1,000.
• MILLIS - Returns an Instant with the specified number of milliseconds added. This is equivalent to plusNanos(long) with the amount multiplied by 1,000,000.
• SECONDS - Returns an Instant with the specified number of seconds added. This is equivalent to plusSeconds(long).
• MINUTES - Returns an Instant with the specified number of minutes added. This is equivalent to plusSeconds(long) with the amount multiplied by 60.
• HOURS - Returns an Instant with the specified number of hours added. This is equivalent to plusSeconds(long) with the amount multiplied by 3,600.
• HALF_DAYS - Returns an Instant with the specified number of half-days added. This is equivalent to plusSeconds(long) with the amount multiplied by 43,200 (12 hours).
• DAYS - Returns an Instant with the specified number of days added. This is equivalent to plusSeconds(long) with the amount multiplied by 86,400 (24 hours).

All other ChronoUnit instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the argument. In this case, the unit determines whether and how to perform the addition.

This instance is immutable and unaffected by this method call.

plusMillis

fun plusMillis(millisToAdd: Long): Instant!

Returns a copy of this instant with the specified duration in milliseconds added.

This instance is immutable and unaffected by this method call.

plusNanos

fun plusNanos(nanosToAdd: Long): Instant!

Returns a copy of this instant with the specified duration in nanoseconds added.

This instance is immutable and unaffected by this method call.

plusSeconds

fun plusSeconds(secondsToAdd: Long): Instant!

Returns a copy of this instant with the specified duration in seconds added.

This instance is immutable and unaffected by this method call.

query

fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this instant using the specified 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.

range

fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified 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 an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

toEpochMilli

fun toEpochMilli(): Long

Converts this instant to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z.

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.

toString

fun toString(): String

A string representation of this instant using ISO-8601 representation.

The format used is the same as DateTimeFormatter#ISO_INSTANT.

truncatedTo

fun truncatedTo(unit: TemporalUnit!): Instant!

Returns a copy of this Instant truncated to the specified unit.

Truncating the instant returns a copy of the original with fields smaller than the specified unit set to zero. The fields are calculated on the basis of using a UTC offset as seen in toString. For example, truncating with the MINUTES unit will round down to the nearest minute, setting the seconds and nanoseconds to zero.

The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.

This instance is immutable and unaffected by this method call.

until

fun until(
    endExclusive: Temporal!, 
    unit: TemporalUnit!
): Long

Calculates the amount of time until another instant in terms of the specified unit.

This calculates the amount of time between two Instant objects in terms of a single TemporalUnit. 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 is converted to a Instant using from(java.time.temporal.TemporalAccessor). For example, the amount in seconds between two dates can be calculated using startInstant.until(endInstant, SECONDS).

There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit#between(Temporal, Temporal):

// these two lines are equivalent
    amount = start.until(end, SECONDS);
    amount = SECONDS.between(start, end);
  

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 converted input temporal as the second argument.

This instance is immutable and unaffected by this method call.

with

fun with(adjuster: TemporalAdjuster!): Instant!

Returns an adjusted copy of this instant.

This returns an Instant, based on this one, with the instant 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

fun with(
    field: TemporalField!, 
    newValue: Long
): Instant!

Returns a copy of this instant with the specified field set to a new value.

This returns an 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 an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(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.

EPOCH

static val EPOCH: Instant!

Constant for the 1970-01-01T00:00:00Z epoch instant.

MAX

static val MAX: Instant!

The maximum supported Instant, '1000000000-12-31T23:59:59.999999999Z'. 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.

MIN

static val MIN: Instant!

The minimum supported 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.