org.opendaylight.controller.md.sal.common.api

Class MappingCheckedFuture<V,X extends Exception>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.util.concurrent.ForwardingFuture<V>

com.google.common.util.concurrent.ForwardingListenableFuture<V>

com.google.common.util.concurrent.ForwardingListenableFuture.SimpleForwardingListenableFuture<V>

com.google.common.util.concurrent.AbstractCheckedFuture<V,X>

org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture<V,X>

Type Parameters:

V - The result type returned by this Future's get method

X - The checked exception type

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<V,X>, com.google.common.util.concurrent.ListenableFuture<V>, Future<V>

public final class MappingCheckedFuture<V,X extends Exception>
extends com.google.common.util.concurrent.AbstractCheckedFuture<V,X>

An implementation of CheckedFuture that provides similar behavior for the get methods that the checkedGet methods provide.

For CancellationException and InterruptedException, the specified exception mapper is invoked to translate them to the checked exception type.

For ExecutionException, the mapper is invoked to translate the cause to the checked exception and a new ExecutionException is thrown with the translated cause.

Author:

Thomas Pantelis

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.util.concurrent.ForwardingListenableFuture

com.google.common.util.concurrent.ForwardingListenableFuture.SimpleForwardingListenableFuture<V>

Nested classes/interfaces inherited from class com.google.common.util.concurrent.ForwardingFuture

com.google.common.util.concurrent.ForwardingFuture.SimpleForwardingFuture<V>

Method Summary

Modifier and Type	Method and Description
static <V,X extends Exception> MappingCheckedFuture<V,X>	create(com.google.common.util.concurrent.ListenableFuture<V> delegate, Function<Exception,X> mapper) Creates a new MappingCheckedFuture that wraps the given ListenableFuture delegate.
V	get()
V	get(long timeout, TimeUnit unit)
protected X	mapException(Exception e)

Methods inherited from class com.google.common.util.concurrent.AbstractCheckedFuture

checkedGet, checkedGet

Methods inherited from class com.google.common.util.concurrent.ForwardingListenableFuture.SimpleForwardingListenableFuture

delegate

Methods inherited from class com.google.common.util.concurrent.ForwardingListenableFuture

addListener

Methods inherited from class com.google.common.util.concurrent.ForwardingFuture

cancel, isCancelled, isDone

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Methods inherited from interface java.util.concurrent.Future

cancel, isCancelled, isDone

Method Detail

create

public static <V,X extends Exception> MappingCheckedFuture<V,X> create(com.google.common.util.concurrent.ListenableFuture<V> delegate,
                                                                       Function<Exception,X> mapper)

Creates a new MappingCheckedFuture that wraps the given ListenableFuture delegate.

Parameters:

delegate - the ListenableFuture to wrap

mapper - the mapping Function used to translate exceptions from the delegate

Returns:

a new MappingCheckedFuture

mapException

protected X mapException(@Nonnull
                         Exception e)

Specified by:

mapException in class com.google.common.util.concurrent.AbstractCheckedFuture<V,X extends Exception>

get

public V get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<V>

Overrides:

get in class com.google.common.util.concurrent.ForwardingFuture<V>

Throws:

InterruptedException

ExecutionException

get

public V get(long timeout,
             @Nonnull
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<V>

Overrides:

get in class com.google.common.util.concurrent.ForwardingFuture<V>

Throws:

InterruptedException

ExecutionException

TimeoutException