Client and backend. This class is shared: the same code is compiled into your app and into your server, so everything on this page works in both.

public final class Instant

  1. Object
  2. Instant

ImplementsComparable<Instant>, Temporal, TemporalAccessor

A moment on the time line, in seconds and nanoseconds from 1970-01-01T00:00:00Z.

Fields

public static final Instant EPOCH1970-01-01T00:00:00Z.
public static final Instant MINThe earliest instant, -1000000000-01-01T00:00Z.
public static final Instant MAXThe latest instant, 1000000000-12-31T23:59:59.999999999Z.

Methods

public static Instant now()
public static Instant now(Clock clock)The moment now on clock.
public static Instant ofEpochMilli(long epochMilli)
public static Instant ofEpochSecond(long epochSecond)
public static Instant ofEpochSecond(long epochSecond, long nanoAdjustment)
public static Instant from(TemporalAccessor temporal)The moment temporal is.
public static Instant parse(CharSequence text)
public long getEpochSecond()
public int getNano()
public long toEpochMilli()The milliseconds since the epoch, or ArithmeticException past what a long holds.
public boolean isSupported(TemporalUnit unit)Whether this value can add or subtract unit.
public Instant plus(long amountToAdd, TemporalUnit unit)This value moved forward by amountToAdd of unit.
public Instant minus(long amountToSubtract, TemporalUnit unit)This value moved back by amountToSubtract of unit.
public Instant plus(TemporalAmount amount)This value moved forward by amount.
public Instant minus(TemporalAmount amount)This value moved back by amount.
public Instant plusSeconds(long secondsToAdd)
public Instant plusMillis(long millisToAdd)
public Instant plusNanos(long nanosToAdd)
public Instant minusSeconds(long secondsToSubtract)
public Instant minusMillis(long millisToSubtract)
public Instant minusNanos(long nanosToSubtract)
public Instant truncatedTo(TemporalUnit unit)This moment with everything smaller than unit dropped.
public long until(Temporal endExclusive, TemporalUnit unit)The whole units of unit from this moment to endExclusive.
public ZonedDateTime atZone(ZoneId zone)This moment in zone.
public OffsetDateTime atOffset(ZoneOffset offset)This moment at offset.
public boolean isAfter(Instant otherInstant)
public boolean isBefore(Instant otherInstant)
public int compareTo(Instant other)Compares this object to the specified object to determine their relative order.
public boolean equals(Object obj)Indicates whether some other object is “equal to” this one.
public int hashCode()Returns a hash code value for the object.
public String toString()Returns a string representation of the object.

Inherited methods

Field details

EPOCH

public static final Instant EPOCH
1970-01-01T00:00:00Z.

MIN

public static final Instant MIN
The earliest instant, -1000000000-01-01T00:00Z.

MAX

public static final Instant MAX
The latest instant, 1000000000-12-31T23:59:59.999999999Z.

Method details

now

public static Instant now()

now

public static Instant now(Clock clock)
The moment now on clock.

ofEpochMilli

public static Instant ofEpochMilli(long epochMilli)

ofEpochSecond

public static Instant ofEpochSecond(long epochSecond)

ofEpochSecond

public static Instant ofEpochSecond(long epochSecond, long nanoAdjustment)

from

public static Instant from(TemporalAccessor temporal)
The moment temporal is.

parse

public static Instant parse(CharSequence text)

getEpochSecond

public long getEpochSecond()

getNano

public int getNano()

toEpochMilli

public long toEpochMilli()
The milliseconds since the epoch, or ArithmeticException past what a long holds.

isSupported

public boolean isSupported(TemporalUnit unit)
Whether this value can add or subtract unit.

plus

public Instant plus(long amountToAdd, TemporalUnit unit)
This value moved forward by amountToAdd of unit.

minus

public Instant minus(long amountToSubtract, TemporalUnit unit)
This value moved back by amountToSubtract of unit.

plus

public Instant plus(TemporalAmount amount)
This value moved forward by amount.

minus

public Instant minus(TemporalAmount amount)
This value moved back by amount.

plusSeconds

public Instant plusSeconds(long secondsToAdd)

plusMillis

public Instant plusMillis(long millisToAdd)

plusNanos

public Instant plusNanos(long nanosToAdd)

minusSeconds

public Instant minusSeconds(long secondsToSubtract)

minusMillis

public Instant minusMillis(long millisToSubtract)

minusNanos

public Instant minusNanos(long nanosToSubtract)

truncatedTo

public Instant truncatedTo(TemporalUnit unit)
This moment with everything smaller than unit dropped. The unit has to divide a day.

until

public long until(Temporal endExclusive, TemporalUnit unit)
The whole units of unit from this moment to endExclusive.

atZone

public ZonedDateTime atZone(ZoneId zone)
This moment in zone.

atOffset

public OffsetDateTime atOffset(ZoneOffset offset)
This moment at offset.

isAfter

public boolean isAfter(Instant otherInstant)

isBefore

public boolean isBefore(Instant otherInstant)

compareTo

public int compareTo(Instant other)
Compares this object to the specified object to determine their relative order.

Parameters

other Instant
the object to compare to this instance.

Returns

a negative integer if this instance is less than another; a positive integer if this instance is greater than another; 0 if this instance has the same order as another.

Throws

ClassCastException
if another cannot be converted into something comparable to this instance.

equals

public boolean equals(Object obj)
Indicates whether some other object is “equal to” this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

toString

public String toString()
Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + ‘@’ + Integer.toHexString(hashCode())