Package org.opendaylight.infrautils.utils.concurrent

Class ListenableFutures

java.lang.Object

org.opendaylight.infrautils.utils.concurrent.ListenableFutures

public final class ListenableFutures
extends Object

More static utility methods pertaining to Guava's ListenableFuture interface.

Author:

Michael Vorburger.ch

See Also:

Futures

Method Summary

Modifier and Type	Method	Description
static <V> void	addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future, org.slf4j.Logger logger, String message)	Deprecated. Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String) instead.
static <V> void	addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future, org.slf4j.Logger logger, String format, Object arg)	Deprecated. Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String, Object) instead.
static <V> void	addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future, org.slf4j.Logger logger, String format, Object... arguments)	Deprecated. Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String, Object...) instead.
static <V,E extends Exception> V	checkedGet(com.google.common.util.concurrent.ListenableFuture<V> future, Function<? super Exception,E> mapper)
static <V,E extends Exception> V	checkedGet(com.google.common.util.concurrent.ListenableFuture<V> future, Function<? super Exception,E> mapper, long timeout, TimeUnit unit)
static <V> CompletionStage<V>	toCompletionStage(com.google.common.util.concurrent.ListenableFuture<V> future)	Converts a Guava ListenableFuture to a Java 8 CompletionStage.

Methods inherited from class java.lang.Object

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

Method Detail

toCompletionStage

public static <V> CompletionStage<V> toCompletionStage(com.google.common.util.concurrent.ListenableFuture<V> future)

Converts a Guava ListenableFuture to a Java 8 CompletionStage. Callers should not cast the returned CompletionStage by this method to CompletableFuture (as it may not be one). See CompletionStages.toListenableFuture(CompletionStage) for the inverse function of this. and CompletableFutures.toListenableFuture(java.util.concurrent.CompletableFuture) for a related function.

addErrorLogging

@Deprecated
public static <V> void addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future,
                                       org.slf4j.Logger logger,
                                       String message)

Deprecated.

Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String) instead.

Adds a callback to a ListenableFuture which logs any failures.

Instead of using this helper, you should consider directly using Futures.addCallback(ListenableFuture, com.google.common.util.concurrent.FutureCallback, java.util.concurrent.Executor) to add a callback which does real error recovery in case of a failure instead of just logging an error, if you can.

addErrorLogging

@Deprecated
public static <V> void addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future,
                                       org.slf4j.Logger logger,
                                       String format,
                                       Object arg)

Deprecated.

Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String, Object) instead.

Adds a callback to a ListenableFuture which logs any failures.

Instead of using this helper, you should consider directly using Futures.addCallback(ListenableFuture, com.google.common.util.concurrent.FutureCallback, java.util.concurrent.Executor) to add a callback which does real error recovery in case of a failure instead of just logging an error, if you can.

addErrorLogging

@Deprecated
public static <V> void addErrorLogging(com.google.common.util.concurrent.ListenableFuture<V> future,
                                       org.slf4j.Logger logger,
                                       String format,
                                       Object... arguments)

Deprecated.

Use LoggingFutures.addErrorLogging(ListenableFuture, Logger, String, Object...) instead.

Adds a callback to a ListenableFuture which logs any failures.

Instead of using this helper, you should consider directly using Futures.addCallback(ListenableFuture, com.google.common.util.concurrent.FutureCallback, java.util.concurrent.Executor) to add a callback which does real error recovery in case of a failure instead of just logging an error, if you can.

checkedGet

public static <V,E extends Exception> V checkedGet(com.google.common.util.concurrent.ListenableFuture<V> future,
                                                         Function<? super Exception,E> mapper)
                                                  throws E extends Exception

Throws:

E extends Exception

checkedGet

public static <V,E extends Exception> V checkedGet(com.google.common.util.concurrent.ListenableFuture<V> future,
                                                         Function<? super Exception,E> mapper,
                                                         long timeout,
                                                         TimeUnit unit)
                                                  throws E extends Exception,
                                                         TimeoutException

Throws:

E extends Exception

TimeoutException