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 org.jboss.netty.channel;
17  
18  /**
19   * The {@link CompleteChannelFuture} which is succeeded already.  It is
20   * recommended to use {@link Channels#succeededFuture(Channel)} instead of
21   * calling the constructor of this future.
22   */
23  public class SucceededChannelFuture extends CompleteChannelFuture {
24  
25      /**
26       * Creates a new instance.
27       *
28       * @param channel the {@link Channel} associated with this future
29       */
30      public SucceededChannelFuture(Channel channel) {
31          super(channel);
32      }
33  
34      public Throwable getCause() {
35          return null;
36      }
37  
38      public boolean isSuccess() {
39          return true;
40      }
41  
42      public ChannelFuture sync() throws InterruptedException {
43          return this;
44      }
45  
46      public ChannelFuture syncUninterruptibly() {
47          return this;
48      }
49  }