com.google.common.util.concurrent

Class Uninterruptibles

java.lang.Object

com.google.common.util.concurrent.Uninterruptibles

@GwtCompatible(emulated=true)
public final class Uninterruptibles
extends Object

Utilities for treating interruptible operations as uninterruptible. In all cases, if a thread is interrupted during such a call, the call continues to block until the result is available or the timeout elapses, and only then re-interrupts the thread.

Since:

10.0

Author:

Anthony Zana

Method Summary

Modifier and Type	Method and Description
static boolean	awaitUninterruptibly(Condition condition, Duration timeout) Invokes condition.await(timeout, unit) uninterruptibly.
static boolean	awaitUninterruptibly(Condition condition, long timeout, TimeUnit unit) Invokes condition.await(timeout, unit) uninterruptibly.
static void	awaitUninterruptibly(CountDownLatch latch) Invokes latch.await() uninterruptibly.
static boolean	awaitUninterruptibly(CountDownLatch latch, Duration timeout) Invokes latch.await(timeout, unit) uninterruptibly.
static boolean	awaitUninterruptibly(CountDownLatch latch, long timeout, TimeUnit unit) Invokes latch.await(timeout, unit) uninterruptibly.
static <V> V	getUninterruptibly(Future<V> future) Invokes future.get() uninterruptibly.
static <V> V	getUninterruptibly(Future<V> future, Duration timeout) Invokes future.get(timeout, unit) uninterruptibly.
static <V> V	getUninterruptibly(Future<V> future, long timeout, TimeUnit unit) Invokes future.get(timeout, unit) uninterruptibly.
static void	joinUninterruptibly(Thread toJoin) Invokes toJoin.join() uninterruptibly.
static void	joinUninterruptibly(Thread toJoin, Duration timeout) Invokes unit.timedJoin(toJoin, timeout) uninterruptibly.
static void	joinUninterruptibly(Thread toJoin, long timeout, TimeUnit unit) Invokes unit.timedJoin(toJoin, timeout) uninterruptibly.
static <E> void	putUninterruptibly(BlockingQueue<E> queue, E element) Invokes queue.put(element) uninterruptibly.
static void	sleepUninterruptibly(Duration sleepFor) Invokes unit.sleep(sleepFor) uninterruptibly.
static void	sleepUninterruptibly(long sleepFor, TimeUnit unit) Invokes unit.sleep(sleepFor) uninterruptibly.
static <E> E	takeUninterruptibly(BlockingQueue<E> queue) Invokes queue.take() uninterruptibly.
static boolean	tryAcquireUninterruptibly(Semaphore semaphore, Duration timeout) Invokes semaphore.tryAcquire(1, timeout, unit) uninterruptibly.
static boolean	tryAcquireUninterruptibly(Semaphore semaphore, int permits, Duration timeout) Invokes semaphore.tryAcquire(permits, timeout, unit) uninterruptibly.
static boolean	tryAcquireUninterruptibly(Semaphore semaphore, int permits, long timeout, TimeUnit unit) Invokes semaphore.tryAcquire(permits, timeout, unit) uninterruptibly.
static boolean	tryAcquireUninterruptibly(Semaphore semaphore, long timeout, TimeUnit unit) Invokes semaphore.tryAcquire(1, timeout, unit) uninterruptibly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

awaitUninterruptibly

@GwtIncompatible
public static void awaitUninterruptibly(CountDownLatch latch)

Invokes latch.await() uninterruptibly.

awaitUninterruptibly

@CanIgnoreReturnValue
 @GwtIncompatible
 @Beta
public static boolean awaitUninterruptibly(CountDownLatch latch,
                                                                                          Duration timeout)

Invokes latch.await(timeout, unit) uninterruptibly.

Since:

28.0

awaitUninterruptibly

@CanIgnoreReturnValue
 @GwtIncompatible
public static boolean awaitUninterruptibly(CountDownLatch latch,
                                                                                   long timeout,
                                                                                   TimeUnit unit)

Invokes latch.await(timeout, unit) uninterruptibly.

awaitUninterruptibly

@GwtIncompatible
 @Beta
public static boolean awaitUninterruptibly(Condition condition,
                                                                   Duration timeout)

Invokes condition.await(timeout, unit) uninterruptibly.

Since:

28.0

awaitUninterruptibly

@GwtIncompatible
public static boolean awaitUninterruptibly(Condition condition,
                                                            long timeout,
                                                            TimeUnit unit)

Invokes condition.await(timeout, unit) uninterruptibly.

Since:

23.6

joinUninterruptibly

@GwtIncompatible
public static void joinUninterruptibly(Thread toJoin)

Invokes toJoin.join() uninterruptibly.

joinUninterruptibly

@GwtIncompatible
 @Beta
public static void joinUninterruptibly(Thread toJoin,
                                                               Duration timeout)

Invokes unit.timedJoin(toJoin, timeout) uninterruptibly.

Since:

28.0

joinUninterruptibly

@GwtIncompatible
public static void joinUninterruptibly(Thread toJoin,
                                                        long timeout,
                                                        TimeUnit unit)

Invokes unit.timedJoin(toJoin, timeout) uninterruptibly.

getUninterruptibly

@CanIgnoreReturnValue
public static <V> V getUninterruptibly(Future<V> future)
                                                      throws ExecutionException

Invokes future.get() uninterruptibly.

Similar methods:

• To retrieve a result from a Future that is already done, use Futures.getDone.
• To treat InterruptedException uniformly with other exceptions, use Futures.getChecked.
• To get uninterruptibility and remove checked exceptions, use Futures.getUnchecked(java.util.concurrent.Future<V>).

Throws:

ExecutionException - if the computation threw an exception

CancellationException - if the computation was cancelled

getUninterruptibly

@CanIgnoreReturnValue
 @GwtIncompatible
 @Beta
public static <V> V getUninterruptibly(Future<V> future,
                                                                                      Duration timeout)
                                                                               throws ExecutionException,
                                                                                      TimeoutException

Invokes future.get(timeout, unit) uninterruptibly.

Similar methods:

• To retrieve a result from a Future that is already done, use Futures.getDone.
• To treat InterruptedException uniformly with other exceptions, use Futures.getChecked.
• To get uninterruptibility and remove checked exceptions, use Futures.getUnchecked(java.util.concurrent.Future<V>).

Throws:

ExecutionException - if the computation threw an exception

CancellationException - if the computation was cancelled

TimeoutException - if the wait timed out

Since:

28.0

getUninterruptibly

@CanIgnoreReturnValue
 @GwtIncompatible
public static <V> V getUninterruptibly(Future<V> future,
                                                                               long timeout,
                                                                               TimeUnit unit)
                                                                        throws ExecutionException,
                                                                               TimeoutException

Invokes future.get(timeout, unit) uninterruptibly.

Similar methods:

• To retrieve a result from a Future that is already done, use Futures.getDone.
• To treat InterruptedException uniformly with other exceptions, use Futures.getChecked.
• To get uninterruptibility and remove checked exceptions, use Futures.getUnchecked(java.util.concurrent.Future<V>).

Throws:

ExecutionException - if the computation threw an exception

CancellationException - if the computation was cancelled

TimeoutException - if the wait timed out

takeUninterruptibly

@GwtIncompatible
public static <E> E takeUninterruptibly(BlockingQueue<E> queue)

Invokes queue.take() uninterruptibly.

putUninterruptibly

@GwtIncompatible
public static <E> void putUninterruptibly(BlockingQueue<E> queue,
                                                           E element)

Invokes queue.put(element) uninterruptibly.

Throws:

ClassCastException - if the class of the specified element prevents it from being added to the given queue

IllegalArgumentException - if some property of the specified element prevents it from being added to the given queue

sleepUninterruptibly

@GwtIncompatible
 @Beta
public static void sleepUninterruptibly(Duration sleepFor)

Invokes unit.sleep(sleepFor) uninterruptibly.

Since:

28.0

sleepUninterruptibly

@GwtIncompatible
public static void sleepUninterruptibly(long sleepFor,
                                                         TimeUnit unit)

Invokes unit.sleep(sleepFor) uninterruptibly.

tryAcquireUninterruptibly

@GwtIncompatible
 @Beta
public static boolean tryAcquireUninterruptibly(Semaphore semaphore,
                                                                        Duration timeout)

Invokes semaphore.tryAcquire(1, timeout, unit) uninterruptibly.

Since:

28.0

tryAcquireUninterruptibly

@GwtIncompatible
public static boolean tryAcquireUninterruptibly(Semaphore semaphore,
                                                                 long timeout,
                                                                 TimeUnit unit)

Invokes semaphore.tryAcquire(1, timeout, unit) uninterruptibly.

Since:

18.0

tryAcquireUninterruptibly

@GwtIncompatible
 @Beta
public static boolean tryAcquireUninterruptibly(Semaphore semaphore,
                                                                        int permits,
                                                                        Duration timeout)

Invokes semaphore.tryAcquire(permits, timeout, unit) uninterruptibly.

Since:

28.0

tryAcquireUninterruptibly

@GwtIncompatible
public static boolean tryAcquireUninterruptibly(Semaphore semaphore,
                                                                 int permits,
                                                                 long timeout,
                                                                 TimeUnit unit)

Invokes semaphore.tryAcquire(permits, timeout, unit) uninterruptibly.

Since:

18.0