Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.base.AbstractInterval
ReadableInterval
interface should be used when different
kinds of intervals are to be referenced.
AbstractInterval subclasses may be mutable and not thread-safe.
Constructor Summary | |
|
Method Summary | |
protected void |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
DateTime |
|
DateTime |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
Duration |
|
long |
|
Interval |
|
MutableInterval |
|
Period |
|
Period |
|
String |
|
protected void checkInterval(long start, long end)
Validates an interval.
- Parameters:
start
- the start instant in millisecondsend
- the end instant in milliseconds
public boolean contains(long millisInstant)
Does this time interval contain the specified millisecond instant. Non-zero duration intervals are inclusive of the start instant and exclusive of the end. A zero duration interval cannot contain anything.
- Parameters:
millisInstant
- the instant to compare to, millisecond instant from 1970-01-01T00:00:00Z
- Returns:
- true if this time interval contains the millisecond
public boolean contains(ReadableInstant instant)
Does this time interval contain the specified 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)Passing in anull
parameter will have the same effect as callingcontainsNow()
.
- Specified by:
- contains in interface ReadableInterval
- Parameters:
instant
- the instant, null means now
- Returns:
- true if this time interval contains the instant
public boolean contains(ReadableInterval interval)
Does this time interval contain the specified time 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. Thecontains
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)Passing in anull
parameter will have the same effect as callingcontainsNow()
.
- Specified by:
- contains in interface ReadableInterval
- Parameters:
interval
- the time interval to compare to, null means a zero duration interval now
- Returns:
- true if this time interval contains the time interval
public boolean containsNow()
Does this time interval contain the current instant. Non-zero duration intervals are inclusive of the start instant and exclusive of the end. A zero duration interval cannot contain anything.
- Returns:
- true if this time interval contains the current instant
public boolean equals(Object readableInterval)
Compares this object with the specified object for equality based on start and end millis plus the chronology. All ReadableInterval instances are accepted. To compare the duration of two time intervals, usetoDuration()
to get the durations and compare those.
- Specified by:
- equals in interface ReadableInterval
- Parameters:
readableInterval
- a readable interval to check against
- Returns:
- true if the start and end millis are equal
public DateTime getEnd()
Gets the end of this time interval, which is exclusive, as a DateTime.
- Specified by:
- getEnd in interface ReadableInterval
- Returns:
- the end of the time interval
public DateTime getStart()
Gets the start of this time interval, which is inclusive, as a DateTime.
- Specified by:
- getStart in interface ReadableInterval
- Returns:
- the start of the time interval
public int hashCode()
Hashcode compatible with equals method.
- Specified by:
- hashCode in interface ReadableInterval
- Returns:
- suitable hashcode
public boolean isAfter(long millisInstant)
Is this time interval after the specified millisecond instant. Intervals are inclusive of the start instant and exclusive of the end.
- Parameters:
millisInstant
- the instant to compare to, millisecond instant from 1970-01-01T00:00:00Z
- Returns:
- true if this time interval is after the instant
public boolean isAfter(ReadableInstant instant)
Is this time interval after the specified instant. Intervals are inclusive of the start instant and exclusive of the end.
- Specified by:
- isAfter in interface ReadableInterval
- Parameters:
instant
- the instant to compare to, null means now
- Returns:
- true if this time interval is after the instant
public boolean isAfter(ReadableInterval interval)
Is this time interval entirely after the specified interval. Intervals are inclusive of the start instant and exclusive of the end. Only the end time of the specified interval is used in the comparison.
- Specified by:
- isAfter in interface ReadableInterval
- Parameters:
interval
- the interval to compare to, null means now
- Returns:
- true if this time interval is after the interval specified
public boolean isAfterNow()
Is this time interval after the current instant. Intervals are inclusive of the start instant and exclusive of the end.
- Returns:
- true if this time interval is after the current instant
public boolean isBefore(long millisInstant)
Is this time interval before the specified millisecond instant. Intervals are inclusive of the start instant and exclusive of the end.
- Parameters:
millisInstant
- the instant to compare to, millisecond instant from 1970-01-01T00:00:00Z
- Returns:
- true if this time interval is before the instant
public boolean isBefore(ReadableInstant instant)
Is this time interval before the specified instant. Intervals are inclusive of the start instant and exclusive of the end.
- Specified by:
- isBefore in interface ReadableInterval
- Parameters:
instant
- the instant to compare to, null means now
- Returns:
- true if this time interval is before the instant
public boolean isBefore(ReadableInterval interval)
Is this time interval entirely before the specified instant. Intervals are inclusive of the start instant and exclusive of the end.
- Specified by:
- isBefore in interface ReadableInterval
- Parameters:
interval
- the interval to compare to, null means now
- Returns:
- true if this time interval is before the interval specified
public boolean isBeforeNow()
Is this time interval before the current instant. Intervals are inclusive of the start instant and exclusive of the end.
- Returns:
- true if this time interval is before the current instant
public boolean overlaps(ReadableInterval interval)
Does this time interval overlap the specified time 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
- Specified by:
- overlaps in interface ReadableInterval
- Parameters:
interval
- the time interval to compare to, null means a zero length interval now
- Returns:
- true if the time intervals overlap
public Duration toDuration()
Gets the duration of this time interval. The duration is equal to the end millis minus the start millis.
- Specified by:
- toDuration in interface ReadableInterval
- Returns:
- the duration of the time interval
public long toDurationMillis()
Gets the duration of this time interval in milliseconds. The duration is equal to the end millis minus the start millis.
- Specified by:
- toDurationMillis in interface ReadableInterval
- Returns:
- the duration of the time interval in milliseconds
public Interval toInterval()
Get this interval as an immutableInterval
object.
- Specified by:
- toInterval in interface ReadableInterval
- Returns:
- the interval as an Interval object
public MutableInterval toMutableInterval()
Get this time interval as aMutableInterval
. This will always return a newMutableInterval
with the same interval.
- Specified by:
- toMutableInterval in interface ReadableInterval
- Returns:
- the time interval as a MutableInterval object
public Period toPeriod()
Converts the duration of the interval to aPeriod
using the All period type. This method should be used to exract the field values describing the difference between the start and end instants.
- Specified by:
- toPeriod in interface ReadableInterval
- Returns:
- a time period derived from the interval
public Period toPeriod(PeriodType type)
Converts the duration of the interval to aPeriod
using the specified period type. This method should be used to exract the field values describing the difference between the start and end instants.
- Specified by:
- toPeriod in interface ReadableInterval
- Parameters:
type
- the requested type of the duration, null means AllType
- Returns:
- a time period derived from the interval
public String toString()
Output a string in ISO8601 interval format.
- Specified by:
- toString in interface ReadableInterval
- Returns:
- re-parsable string