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 com.google.common.base.Function;
12 import com.google.common.base.Preconditions;
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 javax.annotation.Nonnull;
22 * An implementation of CheckedFuture that provides similar behavior for the <code>get</code> methods
23 * that the <code>checkedGet</code> methods provide.
25 * <p>For {@link CancellationException} and {@link InterruptedException}, the specified exception mapper
26 * is invoked to translate them to the checked exception type.
28 * <p>For {@link ExecutionException}, the mapper is invoked to translate the cause to the checked exception
29 * and a new ExecutionException is thrown with the translated cause.
31 * @author Thomas Pantelis
33 * @param <V> The result type returned by this Future's get method
34 * @param <X> The checked exception type
36 public final class MappingCheckedFuture<V, X extends Exception> extends AbstractCheckedFuture<V, X> {
38 private final Function<Exception, X> mapper;
40 private MappingCheckedFuture( final ListenableFuture<V> delegate, final Function<Exception, X> mapper ) {
42 this.mapper = Preconditions.checkNotNull( mapper );
46 * Creates a new <code>MappingCheckedFuture</code> that wraps the given {@link ListenableFuture}
49 * @param delegate the {@link ListenableFuture} to wrap
50 * @param mapper the mapping {@link Function} used to translate exceptions from the delegate
51 * @return a new <code>MappingCheckedFuture</code>
53 public static <V, X extends Exception> MappingCheckedFuture<V, X> create(
54 final ListenableFuture<V> delegate, final Function<Exception, X> mapper ) {
55 return new MappingCheckedFuture<>(delegate, mapper);
59 protected X mapException( @Nonnull final Exception e ) {
60 return mapper.apply( e );
63 private ExecutionException wrapInExecutionException( final String message, final Exception e ) {
64 return new ExecutionException( message, mapException( e ) );
68 public V get() throws InterruptedException, ExecutionException {
71 } catch (final InterruptedException e) {
72 Thread.currentThread().interrupt();
73 throw wrapInExecutionException( "Operation was interrupted", e );
74 } catch (final CancellationException e) {
75 throw wrapInExecutionException( "Operation was cancelled", e );
76 } catch (final ExecutionException e) {
77 throw wrapInExecutionException( e.getMessage(), e );
82 public V get( final long timeout, @Nonnull final TimeUnit unit )
83 throws InterruptedException, ExecutionException, TimeoutException {
85 return super.get( timeout, unit );
86 } catch (final InterruptedException e) {
87 Thread.currentThread().interrupt();
88 throw wrapInExecutionException( "Operation was interrupted", e );
89 } catch (final CancellationException e) {
90 throw wrapInExecutionException( "Operation was cancelled", e );
91 } catch (final ExecutionException e) {
92 throw wrapInExecutionException( e.getMessage(), e );