1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.lang3.concurrent;
18
19 import java.util.Objects;
20 import java.util.concurrent.ExecutionException;
21 import java.util.concurrent.Future;
22 import java.util.concurrent.TimeUnit;
23 import java.util.concurrent.TimeoutException;
24
25 /**
26 * Proxies to a {@link Future} for subclassing.
27 *
28 * @param <V> The result type returned by this Future's {@link #get()} and {@link #get(long, TimeUnit)} methods.
29 * @since 3.13.0
30 */
31 public abstract class AbstractFutureProxy<V> implements Future<V> {
32
33 private final Future<V> future;
34
35 /**
36 * Constructs a new instance.
37 *
38 * @param future the delegate.
39 */
40 public AbstractFutureProxy(final Future<V> future) {
41 this.future = Objects.requireNonNull(future, "future");
42 }
43
44 @Override
45 public boolean cancel(final boolean mayInterruptIfRunning) {
46 return future.cancel(mayInterruptIfRunning);
47 }
48
49 @Override
50 public V get() throws InterruptedException, ExecutionException {
51 return future.get();
52 }
53
54 @Override
55 public V get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException {
56 return future.get(timeout, unit);
57 }
58
59 /**
60 * Gets the delegate.
61 *
62 * @return the delegate.
63 */
64 public Future<V> getFuture() {
65 return future;
66 }
67
68 @Override
69 public boolean isCancelled() {
70 return future.isCancelled();
71 }
72
73 @Override
74 public boolean isDone() {
75 return future.isDone();
76 }
77
78 }