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  /**
19   * The {@link CompleteFuture} which is succeeded already.  It is
20   * recommended to use {@link EventExecutor#newSucceededFuture(Object)} instead of
21   * calling the constructor of this future.
22   */
23  public final class SucceededFuture<V> extends CompleteFuture<V> {
24      private final V result;
25  
26      /**
27       * Creates a new instance.
28       *
29       * @param executor the {@link EventExecutor} associated with this future
30       */
31      public SucceededFuture(EventExecutor executor, V result) {
32          super(executor);
33          this.result = result;
34      }
35  
36      @Override
37      public Throwable cause() {
38          return null;
39      }
40  
41      @Override
42      public boolean isSuccess() {
43          return true;
44      }
45  
46      @Override
47      public V getNow() {
48          return result;
49      }
50  }