1 /*
2 * Copyright 2012 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.util.concurrent;
17
18 import io.netty.util.internal.ObjectUtil;
19 import io.netty.util.internal.PlatformDependent;
20
21 /**
22 * The {@link CompleteFuture} which is failed already. It is
23 * recommended to use {@link EventExecutor#newFailedFuture(Throwable)}
24 * instead of calling the constructor of this future.
25 */
26 public final class FailedFuture<V> extends CompleteFuture<V> {
27
28 private final Throwable cause;
29
30 /**
31 * Creates a new instance.
32 *
33 * @param executor the {@link EventExecutor} associated with this future
34 * @param cause the cause of failure
35 */
36 public FailedFuture(EventExecutor executor, Throwable cause) {
37 super(executor);
38 this.cause = ObjectUtil.checkNotNull(cause, "cause");
39 }
40
41 @Override
42 public Throwable cause() {
43 return cause;
44 }
45
46 @Override
47 public boolean isSuccess() {
48 return false;
49 }
50
51 @Override
52 public Future<V> sync() {
53 PlatformDependent.throwException(cause);
54 return this;
55 }
56
57 @Override
58 public Future<V> syncUninterruptibly() {
59 PlatformDependent.throwException(cause);
60 return this;
61 }
62
63 @Override
64 public V getNow() {
65 return null;
66 }
67 }