org.joda.time
Class Instant
- Comparable, ReadableInstant, Serializable
public final class Instant
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.
Instant() - Constructs an instance set to the current system millisecond time.
|
Instant(Object instant) - Constructs an instance from an Object that represents a datetime.
|
Instant(long instant) - Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.
|
compareTo , equals , get , get , getZone , hashCode , isAfter , isAfter , isAfterNow , isBefore , isBefore , isBeforeNow , isEqual , isEqual , isEqualNow , isSupported , toDate , toDateTime , toDateTime , toDateTime , toDateTimeISO , toInstant , toMutableDateTime , toMutableDateTime , toMutableDateTime , toMutableDateTimeISO , toString , toString |
Instant
public Instant()
Constructs an instance set to the current system millisecond time.
Instant
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.
instant
- the datetime object, null means now
Instant
public Instant(long instant)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.
instant
- the milliseconds from 1970-01-01T00:00:00Z
getMillis
public long getMillis()
Gets the milliseconds of the instant.
- getMillis in interface ReadableInstant
- the number of milliseconds since 1970-01-01T00:00:00Z
minus
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.
duration
- the duration to reduce this instant by
- a copy of this instant with the duration taken away
minus
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.
duration
- the duration to reduce this instant by
- a copy of this instant with the duration taken away
plus
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.
duration
- the duration to add to this one
- a copy of this instant with the duration added
plus
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.
duration
- the duration to add to this one, null means zero
- a copy of this instant with the duration added
toDateTime
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.
- toDateTime in interface AbstractInstant
- a DateTime using the same millis
toDateTimeISO
public DateTime toDateTimeISO()
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.
- toDateTimeISO in interface AbstractInstant
- a DateTime using the same millis with ISOChronology
toMutableDateTime
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.
- toMutableDateTime in interface AbstractInstant
- a MutableDateTime using the same millis
toMutableDateTimeISO
public MutableDateTime toMutableDateTimeISO()
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.
- toMutableDateTimeISO in interface AbstractInstant
- a MutableDateTime using the same millis with ISOChronology
withDurationAdded
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.
durationToAdd
- the duration to add to this onescalar
- the amount of times to add, such as -1 to subtract once
- a copy of this instant with the duration added
withDurationAdded
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.
durationToAdd
- the duration to add to this one, null means zeroscalar
- the amount of times to add, such as -1 to subtract once
- a copy of this instant with the duration added
withMillis
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
.
newMillis
- the new millis, from 1970-01-01T00:00:00Z
- a copy of this instant with different millis
Copyright (c) 2001-2006 - Joda.org