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.channel;
17  
18  import io.netty.util.concurrent.EventExecutor;
19  
20  /**
21   * The {@link CompleteChannelFuture} which is succeeded already.  It is
22   * recommended to use {@link Channel#newSucceededFuture()} instead of
23   * calling the constructor of this future.
24   */
25  final class SucceededChannelFuture extends CompleteChannelFuture {
26  
27      /**
28       * Creates a new instance.
29       *
30       * @param channel the {@link Channel} associated with this future
31       */
32      SucceededChannelFuture(Channel channel, EventExecutor executor) {
33          super(channel, executor);
34      }
35  
36      @Override
37      public Throwable cause() {
38          return null;
39      }
40  
41      @Override
42      public boolean isSuccess() {
43          return true;
44      }
45  }