| org.joda.time.ReadableInstant
All known Subclasses: org.joda.time.base.AbstractInstant, org.joda.time.Instant,
| ReadableInstant | | public interface ReadableInstant extends Comparable(Code) | | Defines an instant in the datetime continuum.
This interface expresses the datetime as milliseconds from 1970-01-01T00:00:00Z.
The implementation of this interface may be mutable or immutable.
This interface only gives access to retrieve data, never to change it.
Methods in your application should be defined using ReadableInstant
as a parameter if the method only wants to read the instant without needing to know
the specific datetime fields.
author:
Stephen Colebourne
since:
1.0 |
| Method Summary | |
| int | compareTo(Object readableInstant)
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 and the Chronology. | | int | get(DateTimeFieldType type)
Get the value of one of the fields of a datetime. | | Chronology | getChronology()
Gets the chronology of the instant. | | long | getMillis()
Get the value as the number of milliseconds since
the epoch, 1970-01-01T00:00:00Z. | | DateTimeZone | getZone()
Gets the time zone of the instant from the chronology. | | int | hashCode()
Gets a hash code for the instant that is compatible with the
equals method. | | boolean | isAfter(ReadableInstant instant)
Is this instant after the instant passed in
comparing solely by millisecond. | | boolean | isBefore(ReadableInstant instant)
Is this instant before the instant passed in
comparing solely by millisecond. | | boolean | isEqual(ReadableInstant instant)
Is this instant equal to the instant passed in
comparing solely by millisecond. | | boolean | isSupported(DateTimeFieldType field)
Checks whether the field type specified is supported by this implementation. | | Instant | toInstant()
Get the value as a simple immutable Instant object. | | String | toString()
Get the value as a String in a recognisable ISO8601 format. |
| compareTo | | int compareTo(Object readableInstant)(Code) | | 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.
Parameters:
readableInstant - a readable instant to check against negative value if this is less, 0 if equal, or positive value if greater
throws:
NullPointerException - if the object is null
throws:
ClassCastException - if the object type is not supported |
| equals | | boolean equals(Object readableInstant)(Code) | | Compares this object with the specified object for equality based
on the millisecond instant and the Chronology. All ReadableInstant
instances are accepted.
To compare two instants for absolute time (ie. UTC milliseconds
ignoring the chronology), use
ReadableInstant.isEqual(ReadableInstant) or
ReadableInstant.compareTo(Object) .
Parameters:
readableInstant - a readable instant to check against true if millisecond and chronology are equal, false ifnot or the instant is null or of an incorrect type |
| get | | int get(DateTimeFieldType type)(Code) | | Get the value of one of the fields of a datetime.
This method uses the chronology of the instant to obtain the value.
Parameters:
type - a field type, usually obtained from DateTimeFieldType, not null the value of that field
throws:
IllegalArgumentException - if the field type is null |
| getChronology | | Chronology getChronology()(Code) | | Gets the chronology of the instant.
The
Chronology provides conversion from the millisecond
value to meaningful fields in a particular calendar system.
the Chronology, never null |
| getMillis | | long getMillis()(Code) | | Get the value as the number of milliseconds since
the epoch, 1970-01-01T00:00:00Z.
the value as milliseconds |
| getZone | | DateTimeZone getZone()(Code) | | Gets the time zone of the instant from the chronology.
the DateTimeZone that the instant is using, never null |
| hashCode | | int hashCode()(Code) | | Gets a hash code for the instant that is compatible with the
equals method.
The formula used must be as follows:
((int) (getMillis() ^ (getMillis() >>> 32))) +
(getChronology().hashCode())
a hash code as defined above |
| isAfter | | boolean isAfter(ReadableInstant instant)(Code) | | Is this instant after the instant passed in
comparing solely by millisecond.
Parameters:
instant - an instant to check against, null means now true if the instant is after the instant passed in |
| isBefore | | boolean isBefore(ReadableInstant instant)(Code) | | Is this instant before the instant passed in
comparing solely by millisecond.
Parameters:
instant - an instant to check against, null means now true if the instant is before the instant passed in |
| isEqual | | boolean isEqual(ReadableInstant instant)(Code) | | Is this instant equal to the instant passed in
comparing solely by millisecond.
Parameters:
instant - an instant to check against, null means now true if the instant is equal to the instant passed in |
| isSupported | | boolean isSupported(DateTimeFieldType field)(Code) | | Checks whether the field type specified is supported by this implementation.
Parameters:
field - the field type to check, may be null which returns false true if the field is supported |
| toInstant | | Instant toInstant()(Code) | | Get the value as a simple immutable Instant object.
This can be useful if you don't trust the implementation
of the interface to be well-behaved, or to get a guaranteed
immutable object.
the value as an Instant object |
| toString | | String toString()(Code) | | Get the value as a String in a recognisable ISO8601 format.
The string output is in ISO8601 format to enable the String
constructor to correctly parse it.
the value as an ISO8601 string |
|
|