io.atlassian.util.concurrent.Awaitable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlassian-util-concurrent Show documentation

This project contains utility classes that are used by various products and projects inside Atlassian and may have some utility to the world at large.

The newest version!

/**
 * Copyright 2008 Atlassian Pty Ltd 
 * 
 * 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.
 */

package io.atlassian.util.concurrent;

import java.util.concurrent.TimeUnit;

/**
 * Something that can be awaited upon.
 *
 * @author Jed Wesley-Smith
 */
public interface Awaitable {

  /**
   * Await for the condition to become true.
   */
  void await() throws InterruptedException;

  /**
   * Await for the specified time for the condition to become true.
   *
   * @param time the amount to wait.
   * @param unit the unit to wait in.
   * @return true if the condition became true within the time limit, false
   * otherwise.
   */
  boolean await(long time, TimeUnit unit) throws InterruptedException;
}