Package org.joda.time.base

Class AbstractInterval

  • All Implemented Interfaces:
    ReadableInterval
    Direct Known Subclasses:
    BaseInterval
    public abstract class AbstractInterval
extends java.lang.Object
implements ReadableInterval
    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.

    Since:
    1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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​(java.lang.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 isEqual​(ReadableInterval other)
      Is this interval equal to the specified interval ignoring the chronology.
      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()
      Converts the duration of the interval to a Period using the All period type.
      Period toPeriod​(PeriodType type)
      Converts the duration of the interval to a Period using the specified period type.
      java.lang.String toString()
      Output a string in ISO8601 interval format.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getStart

        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

      • getEnd

        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

      • contains

        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

      • containsNow

        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

      • contains

        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().
        Specified by:
        contains in interface ReadableInterval
        Parameters:
        instant - the instant, null means now
        Returns:
        true if this time interval contains the instant

      • contains

        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().
        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

      • overlaps

        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

      • isEqual

        public boolean isEqual​(ReadableInterval other)
        Is this interval equal to the specified interval ignoring the chronology.

        This compares the underlying instants, ignoring the chronology.

        Parameters:
        other - a readable interval to check against
        Returns:
        true if the intervals are equal comparing the start and end millis
        Since:
        2.3

      • isBefore

        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

      • isBeforeNow

        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

      • isBefore

        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

      • isBefore

        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

      • isAfter

        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

      • isAfterNow

        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

      • isAfter

        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

      • isAfter

        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

      • toInterval

        public Interval toInterval()
        Get this interval as an immutable Interval object.
        Specified by:
        toInterval in interface ReadableInterval
        Returns:
        the interval as an Interval object

      • toMutableInterval

        public MutableInterval toMutableInterval()
        Get this time interval as a MutableInterval.

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

        Specified by:
        toMutableInterval in interface ReadableInterval
        Returns:
        the time interval as a MutableInterval object

      • toDurationMillis

        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
        Throws:
        java.lang.ArithmeticException - if the duration exceeds the capacity of a long

      • toDuration

        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
        Throws:
        java.lang.ArithmeticException - if the duration exceeds the capacity of a long

      • toPeriod

        public Period toPeriod()
        Converts the duration of the interval to a Period using the All period type.

        This method should be used to extract 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

      • toPeriod

        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 extract 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

      • equals

        public boolean equals​(java.lang.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.

        Specified by:
        equals in interface ReadableInterval
        Overrides:
        equals in class java.lang.Object
        Parameters:
        readableInterval - a readable interval to check against
        Returns:
        true if the intervals are equal comparing the start millis, end millis and chronology

      • hashCode

        public int hashCode()
        Hashcode compatible with equals method.
        Specified by:
        hashCode in interface ReadableInterval
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        suitable hashcode

      • toString

        public java.lang.String toString()
        Output a string in ISO8601 interval format.

        From version 2.1, the string includes the time zone offset.

        Specified by:
        toString in interface ReadableInterval
        Overrides:
        toString in class java.lang.Object
        Returns:
        re-parsable string (in the default zone)