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