rinde.sim.util.TimeWindow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rinsim-core Show documentation
There is a newer version: 4.4.6
package rinde.sim.util;

import static com.google.common.base.Objects.equal;
import static com.google.common.base.Objects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;

import java.io.Serializable;

import javax.annotation.Nullable;

import com.google.common.base.Objects;

/**
 * A time window is an interval in time. It is defined as a half open interval:
 * [begin, end).
 * @author Rinde van Lon 
 */
public final class TimeWindow implements Serializable {
  private static final long serialVersionUID = 7548761538022038612L;

  /**
   * A time window which represents 'always'.
   */
  public final static TimeWindow ALWAYS = new TimeWindow(0, Long.MAX_VALUE);

  /**
   * Begin of the time window (inclusive). Must be a non-negative value.
   */
  public final long begin;

  /**
   * End of the time window (exclusive).
   */
  public final long end;

  /**
   * Create a new time window [begin, end).
   * @param pBegin {@link #begin}.
   * @param pEnd {@link #end}.
   */
  public TimeWindow(long pBegin, long pEnd) {
    checkArgument(pBegin >= 0, "Time must be non-negative.");
    checkArgument(pBegin <= pEnd, "Begin can not be later than end.");
    begin = pBegin;
    end = pEnd;
  }

  /**
   * @param time The time to check.
   * @return true when time is in [{@link #begin},
   *         {@link #end}), false otherwise.
   */
  public boolean isIn(long time) {
    return isAfterStart(time) && isBeforeEnd(time);
  }

  /**
   * @param time The time to check.
   * @return true when time >= {@link #begin},
   *         false otherwise.
   */
  public boolean isAfterStart(long time) {
    return time >= begin;
  }

  /**
   * @param time The time to check.
   * @return true when time < {@link #end},
   *         false otherwise.
   */
  public boolean isBeforeEnd(long time) {
    return time < end;
  }

  /**
   * @param time The time to check.
   * @return true when time < {@link #begin},
   *         false otherwise.
   */
  public boolean isBeforeStart(long time) {
    return time < begin;
  }

  /**
   * @param time The time to check.
   * @return true when time >= {@link #end},
   *         false otherwise.
   */
  public boolean isAfterEnd(long time) {
    return time >= end;
  }

  /**
   * @return The length of the time window:
   *         {@link #end} - {@link #begin}.
   */
  public long length() {
    return end - begin;
  }

  @Override
  public String toString() {
    return toStringHelper(this).add("begin", begin).add("end", end)
        .toString();
  }

  @Override
  public boolean equals(@Nullable Object other) {
    if (other == null) {
      return false;
    }
    if (this == other) {
      return true;
    }
    if (!(other instanceof TimeWindow)) {
      return false;
    }
    final TimeWindow otherTW = (TimeWindow) other;
    return equal(begin, otherTW.begin)
        && equal(end, otherTW.end);
  }

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