Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.base.AbstractInstant
ReadableInstant
interface should be used when different
kinds of date/time objects are to be referenced.
Whenever you want to implement ReadableInstant
you should
extend this class.
AbstractInstant itself is thread-safe and immutable, but subclasses may be
mutable and not thread-safe.
Constructor Summary | |
|
Method Summary | |
int |
|
boolean |
|
int |
|
int |
|
DateTimeZone |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
Date |
|
DateTime |
|
DateTime |
|
DateTime |
|
DateTime |
|
Instant |
|
MutableDateTime |
|
MutableDateTime |
|
MutableDateTime |
|
MutableDateTime |
|
String |
|
String |
|
public int compareTo(Object instant)
Compares this object with the specified object for ascending millisecond instant order. This ordering is inconsistent with equals, as it ignores the Chronology. All ReadableInstant instances are accepted.
- Specified by:
- compareTo in interface ReadableInstant
- Parameters:
instant
- a readable instant to check against
- Returns:
- negative value if this is less, 0 if equal, or positive value if greater
public boolean equals(Object readableInstant)
Compares this object with the specified object for equality based on the millisecond instant, chronology and time zone. Two objects which represent the same instant in time, but are in different time zones (based on time zone id), will be considered to be different. Only two objects with the sameDateTimeZone
,Chronology
and instant are equal. SeeisEqual(ReadableInstant)
for an equals method that ignores the Chronology and time zone. All ReadableInstant instances are accepted.
- Specified by:
- equals in interface ReadableInstant
- Parameters:
readableInstant
- a readable instant to check against
- Returns:
- true if millisecond and chronology are equal, false if not or the instant is null or of an incorrect type
public int get(DateTimeField field)
Get the value of one of the fields of a datetime. This could be used to get a field using a different Chronology. For example:Instant dt = new Instant(); int gjYear = dt.get(Chronology.getCoptic().year());
- Parameters:
field
- the DateTimeField to use, not null
- Returns:
- the value
public int get(DateTimeFieldType type)
Get the value of one of the fields of a datetime using the chronology of the instant. This method uses the chronology of the instant to obtain the value. For example:DateTime dt = new DateTime(); int year = dt.get(DateTimeFieldType.year());
- Specified by:
- get in interface ReadableInstant
- Parameters:
type
- a field type, usually obtained from DateTimeFieldType, not null
- Returns:
- the value of that field
public DateTimeZone getZone()
Gets the time zone of the instant from the chronology.
- Specified by:
- getZone in interface ReadableInstant
- Returns:
- the DateTimeZone that the instant is using, never null
public int hashCode()
Gets a hash code for the instant as defined inReadableInstant
.
- Specified by:
- hashCode in interface ReadableInstant
- Returns:
- a suitable hash code
public boolean isAfter(long instant)
Is this instant after the millisecond instant passed in comparing solely by millisecond.
- Parameters:
instant
- a millisecond instant to check against
- Returns:
- true if this instant is after the instant passed in
public boolean isAfter(ReadableInstant instant)
Is this instant after the instant passed in comparing solely by millisecond.
- Specified by:
- isAfter in interface ReadableInstant
- Parameters:
instant
- an instant to check against, null means now
- Returns:
- true if the instant is after the instant passed in
public boolean isAfterNow()
Is this instant after the current instant comparing solely by millisecond.
- Returns:
- true if this instant is after the current instant
public boolean isBefore(long instant)
Is this instant before the millisecond instant passed in comparing solely by millisecond.
- Parameters:
instant
- a millisecond instant to check against
- Returns:
- true if this instant is before the instant passed in
public boolean isBefore(ReadableInstant instant)
Is this instant before the instant passed in comparing solely by millisecond.
- Specified by:
- isBefore in interface ReadableInstant
- Parameters:
instant
- an instant to check against, null means now
- Returns:
- true if the instant is before the instant passed in
public boolean isBeforeNow()
Is this instant before the current instant comparing solely by millisecond.
- Returns:
- true if this instant is before the current instant
public boolean isEqual(long instant)
Is this instant equal to the millisecond instant passed in comparing solely by millisecond.
- Parameters:
instant
- a millisecond instant to check against
- Returns:
- true if this instant is before the instant passed in
public boolean isEqual(ReadableInstant instant)
Is this instant equal to the instant passed in comparing solely by millisecond.
- Specified by:
- isEqual in interface ReadableInstant
- Parameters:
instant
- an instant to check against, null means now
- Returns:
- true if the instant is equal to the instant passed in
public boolean isEqualNow()
Is this instant equal to the current instant comparing solely by millisecond.
- Returns:
- true if this instant is before the current instant
public boolean isSupported(DateTimeFieldType type)
Checks if the field type specified is supported by this instant and chronology. This can be used to avoid exceptions inget(DateTimeFieldType)
.
- Specified by:
- isSupported in interface ReadableInstant
- Parameters:
type
- a field type, usually obtained from DateTimeFieldType
- Returns:
- true if the field type is supported
public Date toDate()
Get the date time as ajava.util.Date
. TheDate
object created has exactly the same millisecond instant as this object.
- Returns:
- a Date initialised with this datetime
public DateTime toDateTime()
Get this object as a DateTime in the same zone.
- Returns:
- a DateTime using the same millis
public DateTime toDateTime(Chronology chronology)
Get this object as a DateTime using the given chronology and its zone.
- Parameters:
chronology
- chronology to apply, or ISOChronology if null
- Returns:
- a DateTime using the same millis
public DateTime toDateTime(DateTimeZone zone)
Get this object as a DateTime using the same chronology but a different zone.
- Parameters:
zone
- time zone to apply, or default if null
- Returns:
- a DateTime using the same millis
public DateTime toDateTimeISO()
Get this object as a DateTime using ISOChronology in the same zone.
- Returns:
- a DateTime using the same millis with ISOChronology
public Instant toInstant()
Get this object as an Instant.
- Specified by:
- toInstant in interface ReadableInstant
- Returns:
- an Instant using the same millis
public MutableDateTime toMutableDateTime()
Get this object as a MutableDateTime in the same zone.
- Returns:
- a MutableDateTime using the same millis
public MutableDateTime toMutableDateTime(Chronology chronology)
Get this object as a MutableDateTime using the given chronology and its zone.
- Parameters:
chronology
- chronology to apply, or ISOChronology if null
- Returns:
- a MutableDateTime using the same millis
public MutableDateTime toMutableDateTime(DateTimeZone zone)
Get this object as a MutableDateTime using the same chronology but a different zone.
- Parameters:
zone
- time zone to apply, or default if null
- Returns:
- a MutableDateTime using the same millis
public MutableDateTime toMutableDateTimeISO()
Get this object as a MutableDateTime using ISOChronology in the same zone.
- Returns:
- a MutableDateTime using the same millis with ISOChronology
public String toString()
Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).
- Specified by:
- toString in interface ReadableInstant
- Returns:
- ISO8601 time formatted string.
public String toString(DateTimeFormatter formatter)
Uses the specified formatter to convert this partial to a String.
- Parameters:
formatter
- the formatter to use, null means usetoString()
.
- Returns:
- the formatted string
- Since:
- 1.1