2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.yangtools.util.concurrent;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.util.concurrent.AbstractCheckedFuture;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import java.util.concurrent.CancellationException;
16 import java.util.concurrent.ExecutionException;
17 import java.util.concurrent.TimeUnit;
18 import java.util.concurrent.TimeoutException;
19 import java.util.function.Function;
20 import javax.annotation.Nonnull;
23 * An implementation of CheckedFuture that provides similar behavior for the <code>get</code> methods
24 * that the <code>checkedGet</code> methods provide.
26 * <p>For {@link CancellationException} and {@link InterruptedException}, the specified exception mapper
27 * is invoked to translate them to the checked exception type.
29 * <p>For {@link ExecutionException}, the mapper is invoked to translate the cause to the checked exception
30 * and a new ExecutionException is thrown with the translated cause.
32 * @author Thomas Pantelis
34 * @param <V> The result type returned by this Future's get method
35 * @param <X> The checked exception type
37 public final class MappingCheckedFuture<V, X extends Exception> extends AbstractCheckedFuture<V, X> {
39 private final Function<Exception, X> mapper;
41 private MappingCheckedFuture(final ListenableFuture<V> delegate, final Function<Exception, X> mapper) {
43 this.mapper = requireNonNull(mapper);
47 * Creates a new <code>MappingCheckedFuture</code> that wraps the given {@link ListenableFuture}
50 * @param delegate the {@link ListenableFuture} to wrap
51 * @param mapper the mapping {@link Function} used to translate exceptions from the delegate
52 * @return a new <code>MappingCheckedFuture</code>
54 public static <V, X extends Exception> MappingCheckedFuture<V, X> create(
55 final ListenableFuture<V> delegate, final Function<Exception, X> mapper) {
56 return new MappingCheckedFuture<>(delegate, mapper);
60 @SuppressWarnings("checkstyle:parameterName")
61 protected X mapException(@Nonnull final Exception e) {
62 return mapper.apply(e);
65 private ExecutionException wrapInExecutionException(final String message, final Exception ex) {
66 return new ExecutionException(message, mapException(ex));
70 public V get() throws InterruptedException, ExecutionException {
73 } catch (final InterruptedException e) {
74 Thread.currentThread().interrupt();
75 throw wrapInExecutionException("Operation was interrupted", e);
76 } catch (final CancellationException e) {
77 throw wrapInExecutionException("Operation was cancelled", e);
78 } catch (final ExecutionException e) {
79 throw wrapInExecutionException(e.getMessage(), e);
84 public V get(final long timeout, @Nonnull final TimeUnit unit)
85 throws InterruptedException, ExecutionException, TimeoutException {
87 return super.get(timeout, unit);
88 } catch (final InterruptedException e) {
89 Thread.currentThread().interrupt();
90 throw wrapInExecutionException("Operation was interrupted", e);
91 } catch (final CancellationException e) {
92 throw wrapInExecutionException("Operation was cancelled", e);
93 } catch (final ExecutionException e) {
94 throw wrapInExecutionException(e.getMessage(), e);