public abstract class

AbstractInterval

extends Object
implements ReadableInterval
java.lang.Object
   ↳ org.joda.time.base.AbstractInterval
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractInterval provides the common behaviour for time intervals.

This class should generally not be used directly by API users. The ReadableInterval interface should be used when different kinds of intervals are to be referenced.

AbstractInterval subclasses may be mutable and not thread-safe.

Summary

Protected Constructors
AbstractInterval()
Constructor.
Public Methods
boolean contains(long millisInstant)
Does this time interval contain the specified millisecond instant.
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 containsNow()
Does this time interval contain the current instant.
boolean equals(Object readableInterval)
Compares this object with the specified object for equality based on start and end millis plus the chronology.
DateTime getEnd()
Gets the end of this time interval, which is exclusive, as a DateTime.
DateTime getStart()
Gets the start of this time interval, which is inclusive, as a DateTime.
int hashCode()
Hashcode compatible with equals method.
boolean isAfter(long millisInstant)
Is this time interval after the specified millisecond instant.
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 isAfterNow()
Is this time interval after the current instant.
boolean isBefore(long millisInstant)
Is this time interval before the specified millisecond instant.
boolean isBefore(ReadableInstant instant)
Is this time interval before the specified instant.
boolean isBefore(ReadableInterval interval)
Is this time interval entirely before the specified instant.
boolean isBeforeNow()
Is this time interval before the current instant.
boolean overlaps(ReadableInterval interval)
Does this time interval overlap the specified time interval.
Duration toDuration()
Gets the duration of this time interval.
long toDurationMillis()
Gets the duration of this time interval in milliseconds.
Interval toInterval()
Get this interval as an immutable Interval object.
MutableInterval toMutableInterval()
Get this time interval as a MutableInterval.
Period toPeriod(PeriodType type)
Converts the duration of the interval to a Period using the specified period type.
Period toPeriod()
Converts the duration of the interval to a Period using the All period type.
String toString()
Output a string in ISO8601 interval format.
Protected Methods
void checkInterval(long start, long end)
Validates an interval.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.joda.time.ReadableInterval

Protected Constructors

protected AbstractInterval ()

Constructor.

Public Methods

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 a null parameter will have the same effect as calling containsNow().

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. 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)
Passing in a null parameter will have the same effect as calling containsNow().

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, use toDuration() to get the durations and compare those.

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.

Returns
  • the end of the time interval

public DateTime getStart ()

Gets the start of this time interval, which is inclusive, as a DateTime.

Returns
  • the start of the time interval

public int hashCode ()

Hashcode compatible with equals method.

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.

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.

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.

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.

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

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.

Returns
  • the duration of the time interval
Throws
ArithmeticException if the duration exceeds the capacity of a long

public long toDurationMillis ()

Gets the duration of this time interval in milliseconds.

The duration is equal to the end millis minus the start millis.

Returns
  • the duration of the time interval in milliseconds
Throws
ArithmeticException if the duration exceeds the capacity of a long

public Interval toInterval ()

Get this interval as an immutable Interval object.

Returns
  • the interval as an Interval object

public MutableInterval toMutableInterval ()

Get this time interval as a MutableInterval.

This will always return a new MutableInterval with the same interval.

Returns
  • the time interval as a MutableInterval object

public Period toPeriod (PeriodType type)

Converts the duration of the interval to a Period using the specified period type.

This method should be used to exract the field values describing the difference between the start and end instants.

Parameters
type the requested type of the duration, null means AllType
Returns
  • a time period derived from the interval

public Period toPeriod ()

Converts the duration of the interval to a Period using the All period type.

This method should be used to exract the field values describing the difference between the start and end instants.

Returns
  • a time period derived from the interval

public String toString ()

Output a string in ISO8601 interval format.

Returns
  • re-parsable string

Protected Methods

protected void checkInterval (long start, long end)

Validates an interval.

Parameters
start the start instant in milliseconds
end the end instant in milliseconds
Throws
IllegalArgumentException if the interval is invalid