public interface ReadableInterval
A time interval represents a period of time between two instants. Intervals are inclusive of the start instant and exclusive of the end. The end instant is always greater than or equal to the start instant.
Intervals have a fixed millisecond duration.
This is the difference between the start and end instants.
The duration is represented separately by ReadableDuration
.
As a result, intervals are not comparable.
To compare the length of two intervals, you should compare their durations.
An interval can also be converted to a ReadablePeriod
.
This represents the difference between the start and end points in terms of fields
such as years and days.
Methods that are passed an interval as a parameter will treat null
as a zero length interval at the current instant in time.
Modifier and Type | Method and Description |
---|---|
boolean |
contains(ReadableInstant instant)
Does this time interval contain the specified instant.
|
boolean |
contains(ReadableInterval interval)
Does this time interval contain the specified time interval.
|
boolean |
equals(Object readableInterval)
Compares this object with the specified object for equality based
on start and end millis plus the chronology.
|
Chronology |
getChronology()
Gets the chronology of the interval, which is the chronology of the first datetime.
|
DateTime |
getEnd()
Gets the end of this time interval, which is exclusive, as a DateTime.
|
long |
getEndMillis()
Gets the end of this time interval which is exclusive.
|
DateTime |
getStart()
Gets the start of this time interval, which is inclusive, as a DateTime.
|
long |
getStartMillis()
Gets the start of this time interval which is inclusive.
|
int |
hashCode()
Gets a hash code for the time interval that is compatible with the
equals method.
|
boolean |
isAfter(ReadableInstant instant)
Is this time interval after the specified instant.
|
boolean |
isAfter(ReadableInterval interval)
Is this time interval entirely after the specified interval.
|
boolean |
isBefore(ReadableInstant instant)
Is this time interval before the specified instant.
|
boolean |
isBefore(ReadableInterval interval)
Is this time interval entirely before the specified interval.
|
boolean |
overlaps(ReadableInterval interval)
Does this time interval overlap the specified time interval.
|
Duration |
toDuration()
Gets the millisecond duration of this time interval.
|
long |
toDurationMillis()
Gets the millisecond duration of this time interval.
|
Interval |
toInterval()
Get this interval as an immutable
Interval object. |
MutableInterval |
toMutableInterval()
Get this time interval as a
MutableInterval . |
Period |
toPeriod()
Converts the duration of the interval to a period using the
standard period type.
|
Period |
toPeriod(PeriodType type)
Converts the duration of the interval to a period using the
specified period type.
|
String |
toString()
Get the value as a String in the ISO8601 interval format.
|
Chronology getChronology()
long getStartMillis()
DateTime getStart()
long getEndMillis()
DateTime getEnd()
boolean contains(ReadableInstant instant)
Non-zero duration intervals are inclusive of the start instant and exclusive of the end. A zero duration interval cannot contain anything.
For example:
[09:00 to 10:00) contains 08:59 = false (before start) [09:00 to 10:00) contains 09:00 = true [09:00 to 10:00) contains 09:59 = true [09:00 to 10:00) contains 10:00 = false (equals end) [09:00 to 10:00) contains 10:01 = false (after end) [14:00 to 14:00) contains 14:00 = false (zero duration contains nothing)
instant
- the instant, null means nowboolean contains(ReadableInterval interval)
Non-zero duration intervals are inclusive of the start instant and exclusive of the end. The other interval is contained if this interval wholly contains, starts, finishes or equals it. A zero duration interval cannot contain anything.
When two intervals are compared the result is one of three states:
(a) they abut, (b) there is a gap between them, (c) they overlap.
The contains
method is not related to these states.
In particular, a zero duration interval is contained at the start of
a larger interval, but does not overlap (it abuts instead).
For example:
[09:00 to 10:00) contains [09:00 to 10:00) = true [09:00 to 10:00) contains [09:00 to 09:30) = true [09:00 to 10:00) contains [09:30 to 10:00) = true [09:00 to 10:00) contains [09:15 to 09:45) = true [09:00 to 10:00) contains [09:00 to 09:00) = true [09:00 to 10:00) contains [08:59 to 10:00) = false (otherStart before thisStart) [09:00 to 10:00) contains [09:00 to 10:01) = false (otherEnd after thisEnd) [09:00 to 10:00) contains [10:00 to 10:00) = false (otherStart equals thisEnd) [14:00 to 14:00) contains [14:00 to 14:00) = false (zero duration contains nothing)
interval
- the time interval to compare to, null means a zero duration interval nowboolean overlaps(ReadableInterval interval)
Intervals are inclusive of the start instant and exclusive of the end. An interval overlaps another if it shares some common part of the datetime continuum.
When two intervals are compared the result is one of three states: (a) they abut, (b) there is a gap between them, (c) they overlap. The abuts state takes precedence over the other two, thus a zero duration interval at the start of a larger interval abuts and does not overlap.
For example:
[09:00 to 10:00) overlaps [08:00 to 08:30) = false (completely before) [09:00 to 10:00) overlaps [08:00 to 09:00) = false (abuts before) [09:00 to 10:00) overlaps [08:00 to 09:30) = true [09:00 to 10:00) overlaps [08:00 to 10:00) = true [09:00 to 10:00) overlaps [08:00 to 11:00) = true [09:00 to 10:00) overlaps [09:00 to 09:00) = false (abuts before) [09:00 to 10:00) overlaps [09:00 to 09:30) = true [09:00 to 10:00) overlaps [09:00 to 10:00) = true [09:00 to 10:00) overlaps [09:00 to 11:00) = true [09:00 to 10:00) overlaps [09:30 to 09:30) = true [09:00 to 10:00) overlaps [09:30 to 10:00) = true [09:00 to 10:00) overlaps [09:30 to 11:00) = true [09:00 to 10:00) overlaps [10:00 to 10:00) = false (abuts after) [09:00 to 10:00) overlaps [10:00 to 11:00) = false (abuts after) [09:00 to 10:00) overlaps [10:30 to 11:00) = false (completely after) [14:00 to 14:00) overlaps [14:00 to 14:00) = false (abuts before and after) [14:00 to 14:00) overlaps [13:00 to 15:00) = true
interval
- the time interval to compare to, null means a zero length interval nowboolean isAfter(ReadableInstant instant)
Intervals are inclusive of the start instant and exclusive of the end.
instant
- the instant to compare to, null means nowboolean isAfter(ReadableInterval interval)
Intervals are inclusive of the start instant and exclusive of the end.
interval
- the interval to compare to, null means nowboolean isBefore(ReadableInstant instant)
Intervals are inclusive of the start instant and exclusive of the end.
instant
- the instant to compare to, null means nowboolean isBefore(ReadableInterval interval)
Intervals are inclusive of the start instant and exclusive of the end.
interval
- the interval to compare to, null means nowInterval toInterval()
Interval
object.
This will either typecast this instance, or create a new Interval
.
MutableInterval toMutableInterval()
MutableInterval
.
This will always return a new MutableInterval
with the same interval.
Duration toDuration()
ArithmeticException
- if the duration exceeds the capacity of a longlong toDurationMillis()
ArithmeticException
- if the duration exceeds the capacity of a longPeriod toPeriod()
This method should be used to extract the field values describing the difference between the start and end instants.
Period toPeriod(PeriodType type)
This method should be used to extract the field values describing the difference between the start and end instants.
type
- the requested type of the duration, null means standardboolean equals(Object readableInterval)
To compare the duration of two time intervals, use toDuration()
to get the durations and compare those.
int hashCode()
The formula used must be as follows:
int result = 97; result = 31 * result + ((int) (getStartMillis() ^ (getStartMillis() >>> 32))); result = 31 * result + ((int) (getEndMillis() ^ (getEndMillis() >>> 32))); result = 31 * result + getChronology().hashCode(); return result;
Copyright © 2002–2024 Joda.org. All rights reserved.