Summary: Ctors | Methods | Inherited Methods | [Expand All]

public final class

Instant

extends AbstractInstant
implements Serializable ReadableInstant

java.lang.Object
↳	org.joda.time.base.AbstractInstant
	↳	org.joda.time.Instant

Class Overview

Instant is the standard implementation of a fully immutable instant in time.

Instant is an implementation of ReadableInstant. As with all instants, it represents an exact point on the time-line, but limited to the precision of milliseconds. An Instant should be used to represent a point in time irrespective of any other factor, such as chronology or time zone.

Internally, the class holds one piece of data, the instant as milliseconds from the Java epoch of 1970-01-01T00:00:00Z.

For example, an Instant can be used to compare two DateTime objects irrespective of chronology or time zone.

 boolean sameInstant = dt1.toInstant().equals(dt2.toInstant());

Note that the following code will also perform the same check:

 boolean sameInstant = dt1.isEqual(dt2);

Instant is thread-safe and immutable.

Summary

Public Constructors
	Instant() Constructs an instance set to the current system millisecond time.
	Instant(long instant) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.
	Instant(Object instant) Constructs an instance from an Object that represents a datetime.

Public Methods
Chronology	getChronology() Gets the chronology of the instant, which is ISO in the UTC zone.
long	getMillis() Gets the milliseconds of the instant.
Instant	minus(long duration) Gets a copy of this instant with the specified duration taken away.
Instant	minus(ReadableDuration duration) Gets a copy of this instant with the specified duration taken away.
Instant	plus(ReadableDuration duration) Gets a copy of this instant with the specified duration added.
Instant	plus(long duration) Gets a copy of this instant with the specified duration added.
DateTime	toDateTime() Get this object as a DateTime using ISOChronology in the default zone.
DateTime	toDateTimeISO() This method is deprecated. Use toDateTime() as it is identical
Instant	toInstant() Get this object as an Instant by returning `this`.
MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime using ISOChronology in the default zone.
MutableDateTime	toMutableDateTimeISO() This method is deprecated. Use toMutableDateTime() as it is identical
Instant	withDurationAdded(long durationToAdd, int scalar) Gets a copy of this instant with the specified duration added.
Instant	withDurationAdded(ReadableDuration durationToAdd, int scalar) Gets a copy of this instant with the specified duration added.
Instant	withMillis(long newMillis) Gets a copy of this instant with different millis.

[Expand]

Inherited Methods

From class org.joda.time.base.AbstractInstant

int	compareTo(Object instant) Compares this object with the specified object for ascending millisecond instant order.
boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant, chronology and time zone.
int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime using the chronology of the instant.
int	get(DateTimeField field) Get the value of one of the fields of a datetime.
DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
int	hashCode() Gets a hash code for the instant as defined in `ReadableInstant`.
boolean	isAfter(long instant) Is this instant after the millisecond instant passed in comparing solely by millisecond.
boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
boolean	isAfterNow() Is this instant after the current instant comparing solely by millisecond.
boolean	isBefore(long instant) Is this instant before the millisecond instant passed in comparing solely by millisecond.
boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
boolean	isBeforeNow() Is this instant before the current instant comparing solely by millisecond.
boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
boolean	isEqual(long instant) Is this instant equal to the millisecond instant passed in comparing solely by millisecond.
boolean	isEqualNow() Is this instant equal to the current instant comparing solely by millisecond.
boolean	isSupported(DateTimeFieldType type) Checks if the field type specified is supported by this instant and chronology.
Date	toDate() Get the date time as a `java.util.Date`.
DateTime	toDateTime(Chronology chronology) Get this object as a DateTime using the given chronology and its zone.
DateTime	toDateTime(DateTimeZone zone) Get this object as a DateTime using the same chronology but a different zone.
DateTime	toDateTime() Get this object as a DateTime in the same zone.
DateTime	toDateTimeISO() Get this object as a DateTime using ISOChronology in the same zone.
Instant	toInstant() Get this object as an Instant.
MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime in the same zone.
MutableDateTime	toMutableDateTime(Chronology chronology) Get this object as a MutableDateTime using the given chronology and its zone.
MutableDateTime	toMutableDateTime(DateTimeZone zone) Get this object as a MutableDateTime using the same chronology but a different zone.
MutableDateTime	toMutableDateTimeISO() Get this object as a MutableDateTime using ISOChronology in the same zone.
String	toString() Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).
String	toString(DateTimeFormatter formatter) Uses the specified formatter to convert this partial to a String.

From class java.lang.Object

From interface java.lang.Comparable

From interface org.joda.time.ReadableInstant

abstract int	compareTo(Object readableInstant) Compares this object with the specified object for ascending millisecond instant order.
abstract boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant and the Chronology.
abstract int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
abstract Chronology	getChronology() Gets the chronology of the instant.
abstract long	getMillis() Get the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.
abstract DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
abstract int	hashCode() Gets a hash code for the instant that is compatible with the equals method.
abstract boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
abstract boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
abstract boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
abstract boolean	isSupported(DateTimeFieldType field) Checks whether the field type specified is supported by this implementation.
abstract Instant	toInstant() Get the value as a simple immutable `Instant` object.
abstract String	toString() Get the value as a String in a recognisable ISO8601 format.

Public Constructors

public Instant ()

Constructs an instance set to the current system millisecond time.

public Instant (long instant)

Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z

public Instant (Object instant)

Constructs an instance from an Object that represents a datetime.

The recognised object types are defined in ConverterManager and include String, Calendar and Date.

Parameters

instant	the datetime object, null means now

Throws

IllegalArgumentException	if the instant is invalid

Public Methods

public Chronology getChronology ()

Gets the chronology of the instant, which is ISO in the UTC zone.

This method returns getInstanceUTC() which corresponds to the definition of the Java epoch 1970-01-01T00:00:00Z.

Returns

ISO in the UTC zone

public long getMillis ()

Gets the milliseconds of the instant.

Returns

the number of milliseconds since 1970-01-01T00:00:00Z

public Instant minus (long duration)

Gets a copy of this instant with the specified duration taken away.

If the amount is zero or null, then this is returned.

Parameters

duration	the duration to reduce this instant by

Returns

a copy of this instant with the duration taken away

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public Instant minus (ReadableDuration duration)

Gets a copy of this instant with the specified duration taken away.

If the amount is zero or null, then this is returned.

Parameters

duration	the duration to reduce this instant by

Returns

a copy of this instant with the duration taken away

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public Instant plus (ReadableDuration duration)

Gets a copy of this instant with the specified duration added.

If the amount is zero or null, then this is returned.

Parameters

duration	the duration to add to this one, null means zero

Returns

a copy of this instant with the duration added

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public Instant plus (long duration)

Gets a copy of this instant with the specified duration added.

If the amount is zero or null, then this is returned.

Parameters

duration	the duration to add to this one

Returns

a copy of this instant with the duration added

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public DateTime toDateTime ()

Get this object as a DateTime using ISOChronology in the default zone.

This method returns a DateTime object in the default zone. This differs from the similarly named method on DateTime, DateMidnight or MutableDateTime which retains the time zone. The difference is because Instant really represents a time without a zone, thus calling this method we really have no zone to 'retain' and hence expect to switch to the default zone.

This method definition preserves compatability with earlier versions of Joda-Time.

Returns

a DateTime using the same millis

public DateTime toDateTimeISO ()

This method is deprecated.
Use toDateTime() as it is identical

Get this object as a DateTime using ISOChronology in the default zone. This method is identical to toDateTime().

This method returns a DateTime object in the default zone. This differs from the similarly named method on DateTime, DateMidnight or MutableDateTime which retains the time zone. The difference is because Instant really represents a time without a zone, thus calling this method we really have no zone to 'retain' and hence expect to switch to the default zone.

This method definition preserves compatability with earlier versions of Joda-Time.

Returns

a DateTime using the same millis with ISOChronology

public Instant toInstant ()

Get this object as an Instant by returning this.

Returns

this

public MutableDateTime toMutableDateTime ()

Get this object as a MutableDateTime using ISOChronology in the default zone.

This method returns a MutableDateTime object in the default zone. This differs from the similarly named method on DateTime, DateMidnight or MutableDateTime which retains the time zone. The difference is because Instant really represents a time without a zone, thus calling this method we really have no zone to 'retain' and hence expect to switch to the default zone.

This method definition preserves compatability with earlier versions of Joda-Time.

Returns

a MutableDateTime using the same millis

public MutableDateTime toMutableDateTimeISO ()

This method is deprecated.
Use toMutableDateTime() as it is identical

Get this object as a MutableDateTime using ISOChronology in the default zone. This method is identical to toMutableDateTime().

This method returns a MutableDateTime object in the default zone. This differs from the similarly named method on DateTime, DateMidnight or MutableDateTime which retains the time zone. The difference is because Instant really represents a time without a zone, thus calling this method we really have no zone to 'retain' and hence expect to switch to the default zone.

This method definition preserves compatability with earlier versions of Joda-Time.

Returns

a MutableDateTime using the same millis with ISOChronology

public Instant withDurationAdded (long durationToAdd, int scalar)

Gets a copy of this instant with the specified duration added.

If the addition is zero, then this is returned.

Parameters

durationToAdd	the duration to add to this one
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this instant with the duration added

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public Instant withDurationAdded (ReadableDuration durationToAdd, int scalar)

Gets a copy of this instant with the specified duration added.

If the addition is zero, then this is returned.

Parameters

durationToAdd	the duration to add to this one, null means zero
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this instant with the duration added

Throws

ArithmeticException	if the new instant exceeds the capacity of a long

public Instant withMillis (long newMillis)

Gets a copy of this instant with different millis.

The returned object will be either be a new Instant or this.

Parameters

newMillis	the new millis, from 1970-01-01T00:00:00Z

Returns

a copy of this instant with different millis

Interfaces

Classes

Exceptions

Instant

Class Overview

Summary

Public Constructors

public Instant ()

public Instant (long instant)

Parameters

public Instant (Object instant)

Parameters

Throws

Public Methods

public Chronology getChronology ()

Returns

public long getMillis ()

Returns

public Instant minus (long duration)

Parameters

Returns

Throws

public Instant minus (ReadableDuration duration)

Parameters

Returns

Throws

public Instant plus (ReadableDuration duration)

Parameters

Returns

Throws

public Instant plus (long duration)

Parameters

Returns

Throws

public DateTime toDateTime ()

Returns

public DateTime toDateTimeISO ()

Returns

public Instant toInstant ()

Returns

public MutableDateTime toMutableDateTime ()

Returns

public MutableDateTime toMutableDateTimeISO ()

Returns

public Instant withDurationAdded (long durationToAdd, int scalar)

Parameters

Returns

Throws

public Instant withDurationAdded (ReadableDuration durationToAdd, int scalar)

Parameters

Returns

Throws

public Instant withMillis (long newMillis)

Parameters

Returns