org.assertj.swing.util.Range Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Assertj-Swing test framework
The newest version!
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2018 the original author or authors.
 */
package org.assertj.swing.util;

import static org.assertj.core.util.Objects.HASH_CODE_PRIME;

import org.jetbrains.annotations.NotNull;

/**
 * 
 * A range (from, to).
 * 
 *
 * 
 * Usage:
 * 
 *
 *  * Range range = {@link #from(int) from}(0).{@link #to(int) to}(8);
 * 
 *
 * @author Alex Ruiz
 */
public final class Range {
  /**
   * Creates a new {@link From}, representing the starting value of a range.
   *
   * @param value the starting value of the range.
   * @return the created {@code From}.
   */
  public static final @NotNull From from(int value) {
    return new From(value);
  }

  /**
   * Creates a new {@link To}, representing the ending value of a range.
   *
   * @param value the ending value of the range.
   * @return the created {@code To}.
   */
  public static final @NotNull To to(int value) {
    return new To(value);
  }

  /**
   * Starting value of a range.
   *
   * @see Range
   *
   * @author Alex Ruiz
   */
  public static class From {
    public final int value;

    From(int value) {
      this.value = value;
    }

    @Override
    public int hashCode() {
      return HASH_CODE_PRIME * 1 + value;
    }

    @Override
    public boolean equals(Object obj) {
      if (this == obj) {
        return true;
      }
      if (obj == null) {
        return false;
      }
      if (getClass() != obj.getClass()) {
        return false;
      }
      From other = (From) obj;
      return value == other.value;
    }
  }

  /**
   * Ending value of a range.
   *
   * @see Range
   *
   * @author Alex Ruiz
   */
  public static class To {
    public final int value;

    To(int value) {
      this.value = value;
    }

    @Override
    public int hashCode() {
      return HASH_CODE_PRIME * 1 + value;
    }

    @Override
    public boolean equals(Object obj) {
      if (this == obj) {
        return true;
      }
      if (obj == null) {
        return false;
      }
      if (getClass() != obj.getClass()) {
        return false;
      }
      To other = (To) obj;
      return value == other.value;
    }
  }

  private Range() {}
}