Interval (ThreeTen-Extra 1.0 API)

java.lang.Object
- org.threeten.extra.Interval

All Implemented Interfaces:

Serializable
```
public final class Interval
extends Object
implements Serializable
```
An immutable interval of time between two instants.
An interval represents the time on the time-line between two Instants. The class stores the start and end instants, with the start inclusive and the end exclusive. The end instant is always greater than or equal to the start instant.
The Duration of an interval can be obtained, but is a separate concept. An interval is connected to the time-line, whereas a duration is not.
Intervals are not comparable. To compare the length of two intervals, it is generally recommended to compare their durations.
Implementation Requirements:
This class is immutable and thread-safe.
This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`abuts(Interval interval)` Checks if this interval abuts the specified interval.
`boolean`	`contains(Instant instant)` Checks if this interval contains the specified instant.
`boolean`	`encloses(Interval interval)` Checks if this interval encloses the specified interval.
`boolean`	`equals(Object obj)` Checks if this interval is equal to another interval.
`Instant`	`getEnd()` Gets the end of this time interval, exclusive.
`Instant`	`getStart()` Gets the start of this time interval, inclusive.
`int`	`hashCode()` A hash code for this interval.
`boolean`	`isAfter(Instant instant)` Checks if this interval is after the specified instant.
`boolean`	`isAfter(Interval interval)` Checks if this interval is after the specified interval.
`boolean`	`isBefore(Instant instant)` Checks if this interval is before the specified instant.
`boolean`	`isBefore(Interval interval)` Checks if this interval is before the specified interval.
`static Interval`	`of(Instant startInclusive, Duration duration)` Obtains an instance of `Interval` from the start and a duration.
`static Interval`	`of(Instant startInclusive, Instant endExclusive)` Obtains an instance of `Interval` from the start and end instant.
`boolean`	`overlaps(Interval interval)` Checks if this interval overlaps the specified interval.
`static Interval`	`parse(CharSequence text)` Obtains an instance of `Interval` from a text string such as `2007-12-03T10:15:30Z/2007-12-04T10:15:30Z`.
`Duration`	`toDuration()` Obtains the duration of this interval.
`String`	`toString()` Outputs this interval as a `String`, such as `2007-12-03T10:15:30/2007-12-04T10:15:30`.
`Interval`	`withEnd(Instant end)` Creates a new interval with the specified end instant.
`Interval`	`withStart(Instant start)` Creates a new interval with the specified start instant.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static Interval of(Instant startInclusive,
                          Instant endExclusive)
```
    Obtains an instance of Interval from the start and end instant.
    The end instant must not be before the start instant.
    
    Parameters:
    
    startInclusive - the start instant, inclusive, not null
    
    endExclusive - the end instant, exclusive, not null
    
    Returns:
    
    the interval, not null
    
    Throws:
    
    DateTimeException - if the end is before the start
  - of
```
public static Interval of(Instant startInclusive,
                          Duration duration)
```
    Obtains an instance of Interval from the start and a duration.
    The end instant is calculated as the start plus the duration. The duration must not be negative.
    
    Parameters:
    
    startInclusive - the start instant, inclusive, not null
    
    duration - the duration from the start to the end, not null
    
    Returns:
    
    the interval, not null
    
    Throws:
    
    DateTimeException - if the end is before the start, or if the duration addition cannot be made
    
    ArithmeticException - if numeric overflow occurs when adding the duration
  - parse
```
public static Interval parse(CharSequence text)
```
    Obtains an instance of Interval from a text string such as 2007-12-03T10:15:30Z/2007-12-04T10:15:30Z.
    The string must consist of one of the following three formats:
    - a representations of an Instant, followed by a forward slash, followed by a representation of a Instant
    - a representation of an Instant, followed by a forward slash, followed by a representation of a Duration
    - a representation of a Duration, followed by a forward slash, followed by a representation of an Instant
    Parameters:
    
    text - the text to parse, not null
    
    Returns:
    
    the parsed interval, not null
    
    Throws:
    
    DateTimeParseException - if the text cannot be parsed
  - getStart
```
public Instant getStart()
```
    Gets the start of this time interval, inclusive.
    
    Returns:
    
    the start of the time interval
  - getEnd
```
public Instant getEnd()
```
    Gets the end of this time interval, exclusive.
    
    Returns:
    
    the end of the time interval
  - withStart
```
public Interval withStart(Instant start)
```
    Creates a new interval with the specified start instant.
    
    Parameters:
    
    start - the start instant for the new interval, not null
    
    Returns:
    
    an interval with the end from this interval and the specified start
    
    Throws:
    
    IllegalArgumentException - if the resulting interval has end before start
  - withEnd
```
public Interval withEnd(Instant end)
```
    Creates a new interval with the specified end instant.
    
    Parameters:
    
    end - the end instant for the new interval, not null
    
    Returns:
    
    an interval with the start from this interval and the specified end
    
    Throws:
    
    IllegalArgumentException - if the resulting interval has end before start
  - contains
```
public boolean contains(Instant instant)
```
    Checks if this interval contains the specified instant.
    The result is true if the instant is equal or after the start and before the end. An empty interval does not contain anything.
    
    Parameters:
    
    instant - the instant, not null
    
    Returns:
    
    true if this interval contains the instant
  - encloses
```
public boolean encloses(Interval interval)
```
    Checks if this interval encloses the specified interval.
    This checks if the specified interval is fully enclosed by this interval. The result is true if the start of the specified interval is contained in this interval, and the end is contained or equal to the end of this interval. An empty interval contains an equal empty interval, but no other intervals.
    
    Parameters:
    
    interval - the interval, not null
    
    Returns:
    
    true if this interval contains the other interval
  - overlaps
```
public boolean overlaps(Interval interval)
```
    Checks if this interval overlaps the specified interval.
    The result is true if the the two intervals share some part of the time-line. An empty interval overlaps an equal empty interval.
    
    Parameters:
    
    interval - the time interval to compare to, null means a zero length interval now
    
    Returns:
    
    true if the time intervals overlap
  - abuts
```
public boolean abuts(Interval interval)
```
    Checks if this interval abuts the specified interval.
    The result is true if the the two intervals have one instant in common. An empty interval does not abut an equal empty interval.
    
    Parameters:
    
    interval - the interval, not null
    
    Returns:
    
    true if this interval abuts the other interval
  - isAfter
```
public boolean isAfter(Instant instant)
```
    Checks if this interval is after the specified instant.
    The result is true if the this instant starts after the specified instant. An empty interval behaves as though it is an instant for comparison purposes.
    
    Parameters:
    
    instant - the other instant to compare to, not null
    
    Returns:
    
    true if the start of this interval is after the specified instant
  - isBefore
```
public boolean isBefore(Instant instant)
```
    Checks if this interval is before the specified instant.
    The result is true if the this instant ends before the specified instant. Since intervals do not include their end points, this will return true if the instant equals the end of the interval. An empty interval behaves as though it is an instant for comparison purposes.
    
    Parameters:
    
    instant - the other instant to compare to, not null
    
    Returns:
    
    true if the start of this interval is before the specified instant
  - isAfter
```
public boolean isAfter(Interval interval)
```
    Checks if this interval is after the specified interval.
    The result is true if the this instant starts after the end of the specified interval. Since intervals do not include their end points, this will return true if the instant equals the end of the interval. An empty interval behaves as though it is an instant for comparison purposes.
    
    Parameters:
    
    interval - the other interval to compare to, not null
    
    Returns:
    
    true if this instant is after the specified instant
  - isBefore
```
public boolean isBefore(Interval interval)
```
    Checks if this interval is before the specified interval.
    The result is true if the this instant ends before the start of the specified interval. Since intervals do not include their end points, this will return true if the two intervals abut. An empty interval behaves as though it is an instant for comparison purposes.
    
    Parameters:
    
    interval - the other interval to compare to, not null
    
    Returns:
    
    true if this instant is before the specified instant
  - toDuration
```
public Duration toDuration()
```
    Obtains the duration of this interval.
    An Interval is associated with two specific instants on the time-line. A Duration is simply an amount of time, separate from the time-line.
    
    Returns:
    
    the duration of the time interval
    
    Throws:
    
    ArithmeticException - if the calculation exceeds the capacity of Duration
  - equals
```
public boolean equals(Object obj)
```
    Checks if this interval is equal to another interval.
    Compares this Interval with another ensuring that the two instants are the same. Only objects of type Interval are compared, other types return false.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to check, null returns false
    
    Returns:
    
    true if this is equal to the other interval
  - hashCode
```
public int hashCode()
```
    A hash code for this interval.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a suitable hash code
  - toString
```
public String toString()
```
    Outputs this interval as a String, such as 2007-12-03T10:15:30/2007-12-04T10:15:30.
    The output will be the ISO-8601 format formed by combining the toString() methods of the two instants, separated by a forward slash.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this instant, not null

Class Interval

Implementation Requirements:

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

parse

getStart

getEnd

withStart

withEnd

contains

encloses

overlaps

abuts

isAfter

isBefore

isAfter

isBefore

toDuration

equals

hashCode

toString