| java.lang.Object
 org.joda.time.base.AbstractInstant
org.joda.time.Instant
| Instant | | final public class Instant extends AbstractInstant implements ReadableInstant,Serializable(Code) | | 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.
author:
Stephen Colebourne
since:
1.0 |
| Constructor Summary | |
| 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. | | public | Instant(Object instant)
Constructs an instance from an Object that represents a datetime. |
| Method Summary | |
| public Chronology | getChronology()
Gets the chronology of the instant, which is ISO in the UTC zone. | | public long | getMillis()
Gets the milliseconds of the instant. | | public Instant | minus(long duration)
Gets a copy of this instant with the specified duration taken away. | | public Instant | minus(ReadableDuration duration)
Gets a copy of this instant with the specified duration taken away. | | public Instant | plus(long duration)
Gets a copy of this instant with the specified duration added. | | public Instant | plus(ReadableDuration duration)
Gets a copy of this instant with the specified duration added. | | 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. | | public DateTime | toDateTimeISO()
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. | | public Instant | toInstant()
Get this object as an Instant by returning 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. | | public MutableDateTime | toMutableDateTimeISO()
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. | | public Instant | withDurationAdded(long durationToAdd, int scalar)
Gets a copy of this instant with the specified duration added. | | public Instant | withDurationAdded(ReadableDuration durationToAdd, int scalar)
Gets a copy of this instant with the specified duration added. | | public Instant | withMillis(long newMillis)
Gets a copy of this instant with different millis. |
| Instant | | public Instant()(Code) | | Constructs an instance set to the current system millisecond time.
|
| Instant | | public Instant(long instant)(Code) | | Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z |
| Instant | | public Instant(Object instant)(Code) | | 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 |
| getChronology | | public Chronology getChronology()(Code) | | Gets the chronology of the instant, which is ISO in the UTC zone.
This method returns
ISOChronology.getInstanceUTC which
corresponds to the definition of the Java epoch 1970-01-01T00:00:00Z.
ISO in the UTC zone |
| getMillis | | public long getMillis()(Code) | | Gets the milliseconds of the instant.
the number of milliseconds since 1970-01-01T00:00:00Z |
| minus | | public Instant minus(long duration)(Code) | | 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 a copy of this instant with the duration taken away
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| minus | | public Instant minus(ReadableDuration duration)(Code) | | 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 a copy of this instant with the duration taken away
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| plus | | public Instant plus(long duration)(Code) | | 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 a copy of this instant with the duration added
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| plus | | public Instant plus(ReadableDuration duration)(Code) | | 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 a copy of this instant with the duration added
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| toDateTime | | public DateTime toDateTime()(Code) | | 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.
a DateTime using the same millis |
| toDateTimeISO | | public DateTime toDateTimeISO()(Code) | | 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.
a DateTime using the same millis with ISOChronology |
| toInstant | | public Instant toInstant()(Code) | | Get this object as an Instant by returning this.
this |
| toMutableDateTime | | public MutableDateTime toMutableDateTime()(Code) | | 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.
a MutableDateTime using the same millis |
| toMutableDateTimeISO | | public MutableDateTime toMutableDateTimeISO()(Code) | | 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.
a MutableDateTime using the same millis with ISOChronology |
| withDurationAdded | | public Instant withDurationAdded(long durationToAdd, int scalar)(Code) | | 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
Parameters:
scalar - the amount of times to add, such as -1 to subtract once a copy of this instant with the duration added
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| withDurationAdded | | public Instant withDurationAdded(ReadableDuration durationToAdd, int scalar)(Code) | | 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
Parameters:
scalar - the amount of times to add, such as -1 to subtract once a copy of this instant with the duration added
throws:
ArithmeticException - if the new instant exceeds the capacity of a long |
| withMillis | | public Instant withMillis(long newMillis)(Code) | | 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 a copy of this instant with different millis |
|
|