org.interledger.stream.FluentCompareTo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stream-core Show documentation
Core libraries for implementing the STREAM protocol.
There is a newer version: 1.3.1
package org.interledger.stream;

/**
 * Provides a fluent, readable alternative to {@link Comparable#compareTo(Object)}.
 * Instead of code like {@code someValue.compareTo(someOtherValue) <= 0} you can write
 * {@code is(someValue).lessThanOrEqualTo(someOtherValue) }. Also provides stronger type safety so
 * you can't accidentally compare apples to oranges.
 */
public class FluentCompareTo> {

  /**
   * Create a {@link FluentCompareTo} for the given value.
   *
   * @param value value to wrap
   * @param    the Java type of the wrapped value
   * @return wrapped value
   */
  public static > FluentCompareTo is(T value) {
    return new FluentCompareTo(value);
  }

  private final T value;

  private FluentCompareTo(T value) {
    this.value = value;
  }

  /**
   * Checks if wrapped value is equal than the given one.
   *
   * @param other given value
   * @return true if wrapped value is equal to given value
   */
  public boolean equalTo(T other) {
    return value.equals(other);
  }

  /**
   * Checks if wrapped value less than than the given one.
   *
   * @param other given value
   * @return true if wrapped value is less than given value
   */
  public boolean lessThan(T other) {
    return value.compareTo(other) < 0;
  }

  /**
   * Checks if wrapped value less than or equal to than the given one.
   *
   * @param other given value
   * @return true if wrapped value is less than or equal given value
   */
  public boolean lessThanOrEqualTo(T other) {
    return value.compareTo(other) <= 0;
  }

  /**
   * Checks if wrapped value greater than than the given one.
   *
   * @param other given value
   * @return true if wrapped value is greater than given value
   */
  public boolean greaterThan(T other) {
    return value.compareTo(other) > 0;
  }

  /**
   * Checks if wrapped value greater than or equal to than the given one.
   *
   * @param other given value
   * @return true if wrapped value is greater than given value
   */
  public boolean greaterThanEqualTo(T other) {
    return value.compareTo(other) >= 0;
  }

  /**
   * Checks if wrapped value is between 2 given values (inclusive lower bound, exclusive upper bound).
   *
   * @param startInclusive lower bound inclusive value
   * @param endExclusive   upper bound exclusive value
   * @return true if between
   */
  public boolean between(T startInclusive, T endExclusive) {
    return greaterThanEqualTo(startInclusive) && lessThan(endExclusive);
  }

  /**
   * Checks if wrapped value is between 2 given values (exclusive lower bound, exclusive upper bound).
   *
   * @param startExclusive lower bound exclusive value
   * @param endExclusive   upper bound exclusive value
   * @return true if between
   */
  public boolean betweenExclusive(T startExclusive, T endExclusive) {
    return greaterThan(startExclusive) && lessThan(endExclusive);
  }

}