net.minestom.server.utils.math.Range Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of minestom-snapshots Show documentation

1.20.4 Lightweight Minecraft server

There is a newer version: 7320437640

package net.minestom.server.utils.math;

import java.util.Objects;

/**
 * Represents the base for any data type that is numeric.
 *
 * @param  The type numeric of the range object.
 */
public abstract class Range {

  private T minimum;
  private T maximum;

  /**
   * Constructs a new {@link Range} with a {@code minimum} and a {@code maximum} value.
   *
   * @param minimum The minimum of the range.
   * @param maximum The maximum of the range.
   */
  public Range(T minimum, T maximum) {
    this.minimum = minimum;
    this.maximum = maximum;
  }

  /**
   * Constructs a new {@link Range} with the {@code value}.
   *
   * @param value The value of the range.
   */
  public Range(T value) {
    this(value, value);
  }

  /**
   * Retrieves the minimum value of the range.
   *
   * @return The range's minimum value.
   */
  public T getMinimum() {
    return this.minimum;
  }

  /**
   * Changes the minimum value of the range.
   *
   * @param minimum The new minimum value.
   */
  public void setMinimum(T minimum) {
    this.minimum = minimum;
  }

  /**
   * Retrieves the maximum value of the range.
   *
   * @return The range's maximum value.
   */
  public T getMaximum() {
    return this.maximum;
  }

  /**
   * Changes the maximum value of the range.
   *
   * @param maximum The new maximum value.
   */
  public void setMaximum(T maximum) {
    this.maximum = maximum;
  }

  /**
   * Whether the given {@code value} is in range of the minimum and the maximum.
   *
   * @param value The value to be checked.
   * @return {@code true} if the value in the range of {@code minimum} and {@code maximum},
   *     otherwise {@code false}.
   */
  public abstract boolean isInRange(T value);

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Range range = (Range) o;
    return Objects.equals(minimum, range.minimum) && Objects.equals(maximum, range.maximum);
  }

  @Override
  public int hashCode() {
    return Objects.hash(minimum, maximum);
  }

}