Package org.joda.time

Class MutableInterval

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, ReadableInterval, ReadWritableInterval
    public class MutableInterval
extends BaseInterval
implements ReadWritableInterval, java.lang.Cloneable, java.io.Serializable
    MutableInterval is the standard implementation of a mutable time interval.

    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.

    If performing significant calculations on an interval, it may be faster to convert an Interval object to a MutableInterval one.

    MutableInterval is mutable and not thread-safe, unless concurrent threads are not invoking mutator methods.

    Since:
    1.0
    See Also:
    Serialized Form

    • Constructor Detail

      • MutableInterval

        public MutableInterval()
        Constructs a zero length time interval from 1970-01-01 to 1970-01-01.

      • MutableInterval

        public MutableInterval​(long startInstant,
                       long endInstant)
        Constructs an interval from a start and end instant with the ISO default chronology.
        Parameters:
        startInstant - start of this interval, as milliseconds from 1970-01-01T00:00:00Z.
        endInstant - end of this interval, as milliseconds from 1970-01-01T00:00:00Z.
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • MutableInterval

        public MutableInterval​(long startInstant,
                       long endInstant,
                       Chronology chronology)
        Constructs an interval from a start and end instant with a chronology.
        Parameters:
        chronology - the chronology to use, null is ISO default
        startInstant - start of this interval, as milliseconds from 1970-01-01T00:00:00Z.
        endInstant - end of this interval, as milliseconds from 1970-01-01T00:00:00Z.
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • MutableInterval

        public MutableInterval​(ReadableInstant start,
                       ReadableInstant end)
        Constructs an interval from a start and end instant.

        The chronology used is that of the start instant.

        Parameters:
        start - start of this interval, null means now
        end - end of this interval, null means now
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • MutableInterval

        public MutableInterval​(ReadableInstant start,
                       ReadableDuration duration)
        Constructs an interval from a start instant and a duration.
        Parameters:
        start - start of this interval, null means now
        duration - the duration of this interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the end instant exceeds the capacity of a long

      • MutableInterval

        public MutableInterval​(ReadableDuration duration,
                       ReadableInstant end)
        Constructs an interval from a millisecond duration and an end instant.
        Parameters:
        duration - the duration of this interval, null means zero length
        end - end of this interval, null means now
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the start instant exceeds the capacity of a long

      • MutableInterval

        public MutableInterval​(ReadableInstant start,
                       ReadablePeriod period)
        Constructs an interval from a start instant and a time period.

        When forming the interval, the chronology from the instant is used if present, otherwise the chronology of the period is used.

        Parameters:
        start - start of this interval, null means now
        period - the period of this interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the end instant exceeds the capacity of a long

      • MutableInterval

        public MutableInterval​(ReadablePeriod period,
                       ReadableInstant end)
        Constructs an interval from a time period and an end instant.

        When forming the interval, the chronology from the instant is used if present, otherwise the chronology of the period is used.

        Parameters:
        period - the period of this interval, null means zero length
        end - end of this interval, null means now
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the start instant exceeds the capacity of a long

      • MutableInterval

        public MutableInterval​(java.lang.Object interval)
        Constructs a time interval by converting or copying from another object.

        The recognised object types are defined in ConverterManager and include ReadableInterval and String. The String formats are described by ISODateTimeFormat.dateTimeParser() and ISOPeriodFormat.standard(), and may be 'datetime/datetime', 'datetime/period' or 'period/datetime'.

        Parameters:
        interval - the time interval to copy
        Throws:
        java.lang.IllegalArgumentException - if the interval is invalid

      • MutableInterval

        public MutableInterval​(java.lang.Object interval,
                       Chronology chronology)
        Constructs a time interval by converting or copying from another object, overriding the chronology.

        The recognised object types are defined in ConverterManager and include ReadableInterval and String. The String formats are described by ISODateTimeFormat.dateTimeParser() and ISOPeriodFormat.standard(), and may be 'datetime/datetime', 'datetime/period' or 'period/datetime'.

        Parameters:
        interval - the time interval to copy
        chronology - the chronology to use, null means ISO default
        Throws:
        java.lang.IllegalArgumentException - if the interval is invalid

    • Method Detail

      • setInterval

        public void setInterval​(long startInstant,
                        long endInstant)
        Sets this interval from two millisecond instants retaining the chronology.
        Specified by:
        setInterval in interface ReadWritableInterval
        Parameters:
        startInstant - the start of the time interval
        endInstant - the start of the time interval
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setInterval

        public void setInterval​(ReadableInterval interval)
        Sets this interval to be the same as another.
        Specified by:
        setInterval in interface ReadWritableInterval
        Parameters:
        interval - the interval to copy
        Throws:
        java.lang.IllegalArgumentException - if the interval is null

      • setInterval

        public void setInterval​(ReadableInstant start,
                        ReadableInstant end)
        Sets this interval from two instants, replacing the chronology with that from the start instant.
        Specified by:
        setInterval in interface ReadWritableInterval
        Parameters:
        start - the start of the time interval
        end - the start of the time interval
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setChronology

        public void setChronology​(Chronology chrono)
        Sets the chronology of this time interval.
        Specified by:
        setChronology in interface ReadWritableInterval
        Parameters:
        chrono - the chronology to use, null means ISO default

      • setStartMillis

        public void setStartMillis​(long startInstant)
        Sets the start of this time interval.
        Specified by:
        setStartMillis in interface ReadWritableInterval
        Parameters:
        startInstant - the start of the time interval, millisecond instant from 1970-01-01T00:00:00Z
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setStart

        public void setStart​(ReadableInstant start)
        Sets the start of this time interval as an Instant.
        Specified by:
        setStart in interface ReadWritableInterval
        Parameters:
        start - the start of the time interval, null means now
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setEndMillis

        public void setEndMillis​(long endInstant)
        Sets the end of this time interval.
        Specified by:
        setEndMillis in interface ReadWritableInterval
        Parameters:
        endInstant - the end of the time interval, millisecond instant from 1970-01-01T00:00:00Z
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setEnd

        public void setEnd​(ReadableInstant end)
        Sets the end of this time interval as an Instant.
        Specified by:
        setEnd in interface ReadWritableInterval
        Parameters:
        end - the end of the time interval, null means now
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start

      • setDurationAfterStart

        public void setDurationAfterStart​(long duration)
        Sets the duration of this time interval, preserving the start instant.
        Parameters:
        duration - new duration for interval
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the end instant exceeds the capacity of a long

      • setDurationBeforeEnd

        public void setDurationBeforeEnd​(long duration)
        Sets the duration of this time interval, preserving the end instant.
        Parameters:
        duration - new duration for interval
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the start instant exceeds the capacity of a long

      • setDurationAfterStart

        public void setDurationAfterStart​(ReadableDuration duration)
        Sets the duration of this time interval, preserving the start instant.
        Specified by:
        setDurationAfterStart in interface ReadWritableInterval
        Parameters:
        duration - new duration for interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the end instant exceeds the capacity of a long

      • setDurationBeforeEnd

        public void setDurationBeforeEnd​(ReadableDuration duration)
        Sets the duration of this time interval, preserving the end instant.
        Specified by:
        setDurationBeforeEnd in interface ReadWritableInterval
        Parameters:
        duration - new duration for interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the start instant exceeds the capacity of a long

      • setPeriodAfterStart

        public void setPeriodAfterStart​(ReadablePeriod period)
        Sets the period of this time interval, preserving the start instant and using the ISOChronology in the default zone for calculations.
        Specified by:
        setPeriodAfterStart in interface ReadWritableInterval
        Parameters:
        period - new period for interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the end instant exceeds the capacity of a long

      • setPeriodBeforeEnd

        public void setPeriodBeforeEnd​(ReadablePeriod period)
        Sets the period of this time interval, preserving the end instant and using the ISOChronology in the default zone for calculations.
        Specified by:
        setPeriodBeforeEnd in interface ReadWritableInterval
        Parameters:
        period - new period for interval, null means zero length
        Throws:
        java.lang.IllegalArgumentException - if the end is before the start
        java.lang.ArithmeticException - if the start instant exceeds the capacity of a long

      • copy

        public MutableInterval copy()
        Clone this object without having to cast the returned object.
        Returns:
        a clone of the this object.

      • clone

        public java.lang.Object clone()
        Clone this object.
        Returns:
        a clone of this object.