1 /*
2 * Copyright 2009 Red Hat, Inc.
3 *
4 * Red Hat licenses this file to you under the Apache License, version 2.0
5 * (the "License"); you may not use this file except in compliance with the
6 * 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 failed already. It is
20 * recommended to use {@link Channels#failedFuture(Channel, Throwable)}
21 * instead of calling the constructor of this future.
22 *
23 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
24 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
25 *
26 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
27 */
28 public class FailedChannelFuture extends CompleteChannelFuture {
29
30 private final Throwable cause;
31
32 /**
33 * Creates a new instance.
34 *
35 * @param channel the {@link Channel} associated with this future
36 * @param cause the cause of failure
37 */
38 public FailedChannelFuture(Channel channel, Throwable cause) {
39 super(channel);
40 if (cause == null) {
41 throw new NullPointerException("cause");
42 }
43 this.cause = cause;
44 }
45
46 public Throwable getCause() {
47 return cause;
48 }
49
50 public boolean isSuccess() {
51 return false;
52 }
53 }