View Javadoc
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    *   http://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.PlatformDependent;
19  
20  /**
21   * The {@link CompleteFuture} which is failed already.  It is
22   * recommended to use {@link EventExecutor#newFailedFuture(Throwable)}
23   * instead of calling the constructor of this future.
24   */
25  public final class FailedFuture<V> extends CompleteFuture<V> {
26  
27      private final Throwable cause;
28  
29      /**
30       * Creates a new instance.
31       *
32       * @param executor the {@link EventExecutor} associated with this future
33       * @param cause   the cause of failure
34       */
35      public FailedFuture(EventExecutor executor, Throwable cause) {
36          super(executor);
37          if (cause == null) {
38              throw new NullPointerException("cause");
39          }
40          this.cause = cause;
41      }
42  
43      @Override
44      public Throwable cause() {
45          return cause;
46      }
47  
48      @Override
49      public boolean isSuccess() {
50          return false;
51      }
52  
53      @Override
54      public Future<V> sync() {
55          PlatformDependent.throwException(cause);
56          return this;
57      }
58  
59      @Override
60      public Future<V> syncUninterruptibly() {
61          PlatformDependent.throwException(cause);
62          return this;
63      }
64  
65      @Override
66      public V getNow() {
67          return null;
68      }
69  }