Interval (org.macroing.cit.java API)

java.lang.Object
- org.macroing.cit.java.util.Interval<T>

```
public final class Interval<T extends java.lang.Comparable<T>>
extends java.lang.Object
```
A data type that represents an interval.
This class is generic and can be used on any data type that implements the Comparable interface.
To demonstrate how to use this class, consider the following example:
```
 
 Interval<Integer> interval = Interval.of(0, 10);
 
 boolean contains = interval.contains(5);
 
 
```
You may optionally specify the kind of interval you want to use, given an instance of the enum Interval.Kind. This enum contains four values, Kind.CLOSED_CLOSED, Kind.CLOSED_OPEN, Kind.OPEN_CLOSED and Kind.OPEN_OPEN. They all alter the behavior of the methods in this class slightly.
This class has potential to be thread-safe, in which case it's suitable for concurrent use without external synchronization. The Interval class is itself "immutable", but the values stored in it may or may not be.
Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Interval.Kind
An enum that tells the Interval class how it should alter the behavior of its methods.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Interval.Kind` An enum that tells the `Interval` class how it should alter the behavior of its methods.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(T c)` Checks if `c` is contained within this `Interval` instance.
`T`	`getA()` Returns the lesser value of this `Interval` instance.
`T`	`getB()` Returns the greater value of this `Interval` instance.
`Interval.Kind`	`getKind()` Returns the `Interval.Kind` used by this `Interval` instance.
`boolean`	`isGreaterThan(T c)` Checks if `c` is greater than the greater value of this `Interval` instance.
`boolean`	`isLessThan(T c)` Checks if `c` is less than the lesser value of this `Interval` instance.
`static <T extends java.lang.Comparable<T>> Interval<T>`	`of(T a, T b)` Returns an `Interval` instance based on the lesser value of `a` and the greater value of `b`.
`static <T extends java.lang.Comparable<T>> Interval<T>`	`of(T a, T b, Interval.Kind kind)` Returns an `Interval` instance based on the lesser value of `a`, the greater value of `b` and a given `Kind`.
`java.lang.String`	`toString()` Returns a `String` representation of this `Interval` instance.

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

- Method Detail
  - contains
```
public boolean contains(T c)
```
    Checks if c is contained within this Interval instance.
    Returns true if, and only if, c is contained within this Interval instance, false otherwise.
    The behavior that checks for containment of c differs slightly, depending on the Interval.Kind used by this Interval instance.
    If c is null, a NullPointerException will be thrown.
    
    Parameters:
    
    c - the value to check for containment
    
    Returns:
    
    true if, and only if, c is contained within this Interval instance, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, c is null
  - isGreaterThan
```
public boolean isGreaterThan(T c)
```
    Checks if c is greater than the greater value of this Interval instance.
    Returns true if, and only if, c is greater than the greater value of this Interval instance, false otherwise.
    The behavior that governs this method differs slightly, depending on the Interval.Kind used by this Interval instance.
    If c is null, a NullPointerException will be thrown.
    
    Parameters:
    
    c - the value to check
    
    Returns:
    
    true if, and only if, c is greater than the greater value of this Interval instance, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, c is null
  - isLessThan
```
public boolean isLessThan(T c)
```
    Checks if c is less than the lesser value of this Interval instance.
    Returns true if, and only if, c is less than the lesser value of this Interval instance, false otherwise.
    The behavior that governs this method differs slightly, depending on the Interval.Kind used by this Interval instance.
    If c is null, a NullPointerException will be thrown.
    
    Parameters:
    
    c - the value to check
    
    Returns:
    
    true if, and only if, c is less than the lesser value of this Interval instance, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, c is null
  - getKind
```
public Interval.Kind getKind()
```
    Returns the Interval.Kind used by this Interval instance.
    
    Returns:
    
    the Kind used by this Interval instance
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Interval instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Interval instance
  - getA
```
public T getA()
```
    Returns the lesser value of this Interval instance.
    
    Returns:
    
    the lesser value of this Interval instance
  - getB
```
public T getB()
```
    Returns the greater value of this Interval instance.
    
    Returns:
    
    the greater value of this Interval instance
  - of
```
public static <T extends java.lang.Comparable<T>> Interval<T> of(T a,
                                                                 T b)
```
    Returns an Interval instance based on the lesser value of a and the greater value of b.
    Calling this method is equivalent to calling Interval.of(a, b, Kind.CLOSED_CLOSED).
    If either a or b are null, a NullPointerException will be thrown.
    If a is greater than b, an IllegalArgumentException will be thrown.
    
    Type Parameters:
    
    T - the generic type of a and b
    
    Parameters:
    
    a - the lesser value
    
    b - the greater value
    
    Returns:
    
    an Interval instance based on the lesser value of a and the greater value of b
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, a is greater than b
    
    java.lang.NullPointerException - thrown if, and only if, either a or b are null
  - of
```
public static <T extends java.lang.Comparable<T>> Interval<T> of(T a,
                                                                 T b,
                                                                 Interval.Kind kind)
```
    Returns an Interval instance based on the lesser value of a, the greater value of b and a given Kind.
    If either a, b or kind are null, a NullPointerException will be thrown.
    If a is greater than b, an IllegalArgumentException will be thrown.
    
    Type Parameters:
    
    T - the generic type of a and b
    
    Parameters:
    
    a - the lesser value
    
    b - the greater value
    
    kind - the Kind to assign
    
    Returns:
    
    an Interval instance based on the lesser value of a, the greater value of b and a given Kind
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, a is greater than b
    
    java.lang.NullPointerException - thrown if, and only if, either a, b or kind are null

Class Interval<T extends java.lang.Comparable<T>>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

contains

isGreaterThan

isLessThan

getKind

toString

getA

getB

of

of