org.assertj.swing.timing.Timeout 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.timing;

import org.jetbrains.annotations.NotNull;

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

import java.util.concurrent.TimeUnit;

/**
 * Timeout.
 * 
 * @author Yvonne Wang
 * @author Alex Ruiz
 */
public final class Timeout {
  private static final int DEFAULT_DELAY = 30000;

  private final long duration;

  /**
   * Creates a new {@link Timeout} with default duration.
   * 
   * @return the created {@code Timeout}.
   */
  @NotNull
  public static Timeout timeout() {
    return timeout(DEFAULT_DELAY);
  }

  /**
   * Creates a new {@link Timeout}.
   * 
   * @param duration the duration of the timeout in milliseconds.
   * @return the created {@code Timeout}.
   */
  @NotNull
  public static Timeout timeout(long duration) {
    return new Timeout(duration);
  }

  /**
   * Creates a new {@link Timeout}.
   * 
   * @param duration the duration of the timeout.
   * @param timeUnit the unit of time of the timeout.
   * @return the created {@code Timeout}.
   * @throws NullPointerException if the given time unit is {@code null}.
   */
  @NotNull
  public static Timeout timeout(long duration, @NotNull TimeUnit timeUnit) {
    checkNotNull(timeUnit);
    return new Timeout(timeUnit.toMillis(duration));
  }

  private Timeout(long duration) {
    this.duration = duration;
  }

  /**
   * @return the duration of the timeout in milliseconds.
   */
  public long duration() {
    return duration;
  }

  @Override
  public int hashCode() {
    return HASH_CODE_PRIME * 1 + (int) (duration ^ (duration >>> 32));
  }

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