pro.taskana.common.internal.Interval Maven / Gradle / Ivy

Go to download
package pro.taskana.common.internal;

import java.util.Objects;

/**
 * An Interval captures an interval of Type T extends Comparable. A fixed interval has
 * defined begin and end. An open ended interval has either begin == null or end ==null.
 *
 * Example: Interval<Integer> interval = new Interval<>(1, 2); or 
 * Interval<Instant> timeInterval = new Interval<>(instant_1, instant_2)
 */
public class Interval> {

  protected final T begin;

  protected final T end;

  public Interval(T begin, T end) {
    this.begin = begin;
    this.end = end;
  }

  public T getBegin() {
    return begin;
  }

  public T getEnd() {
    return end;
  }

  public boolean contains(T i) {
    if (i == null) {
      return false;
    }
    boolean isAfterBegin = begin == null || i.compareTo(begin) >= 0;
    boolean isBeforeEnd = end == null || i.compareTo(end) <= 0;
    return (isAfterBegin && isBeforeEnd);
  }

  public boolean isValid() {
    boolean isValid = begin != null || end != null;
    if (begin != null && end != null && begin.compareTo(end) > 0) {
      isValid = false;
    }
    return isValid;
  }

  @Override
  public int hashCode() {
    return Objects.hash(begin, end);
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (!(obj instanceof Interval)) {
      return false;
    }
    Interval other = (Interval) obj;
    return Objects.equals(begin, other.begin) && Objects.equals(end, other.end);
  }

  @Override
  public String toString() {
    return "Interval [" + "begin=" + this.begin + ", end=" + this.end + "]";
  }
}