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