Instant

Obtains an instance of 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 ChronoField#INSTANT_SECONDS and ChronoField#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.

Throw:

Obtains the current instant from the system clock, or if specified the current instant from the specified clock.

This will query the specified clock to obtain the current time.

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

Throw:

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.

Throw:

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

Throw:

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

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

Throw:

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 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:

  // 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.

Throw:

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.

Throw:

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.

Throw:

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.

Throw:

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 of the day is returned by getNanosOfSecond.

Checks if this instant is equal to the specified instant.

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

Gets the value of the specified field from this instant as an 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 (see isSupported) 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.getFrom passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Override:

Throw:

Gets the value of the specified field from this instant as a 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 (see isSupported) 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.getFrom passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Override:

Throw:

Returns a hash code for this instant.

Checks if this instant is after the specified instant.

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

Throw:

Checks if this instant is before the specified instant.

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

Throw:

Checks if the specified field is supported.

This checks if this instant can be queried for the specified field. If false, then calling range and get 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

All other ChronoField instances will return false.

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

Override:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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.

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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 method on the specified query passing this as the argument.

Override:

Throw:

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 (see isSupported) 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.rangeRefinedBy passing this as the argument. Whether the range can be obtained is determined by the field.

Override:

Throw:

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.

Throw:

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

The format used is the same as DateTimeFormatter#ISO_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 ChronoUnit#MINUTES will round down to the nearest minute, setting the seconds and nanoseconds to zero.

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

This instance is immutable and unaffected by this method call.

Throw:

Calculates the period between this instant and another instant in terms of the specified 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 is converted to a Instant using from. For example, the period in days between two dates can be calculated using startInstant.until(endInstant, SECONDS).

This method operates in association with TemporalUnit#between. 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.until(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 passing this as the first argument and the input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Override:

Throw: