View Javadoc
1   /*
2    * Copyright 2013 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.group;
17  
18  import io.netty.channel.Channel;
19  import io.netty.channel.ChannelException;
20  import io.netty.channel.ChannelFuture;
21  
22  import java.util.Collection;
23  import java.util.Collections;
24  import java.util.Iterator;
25  import java.util.Map;
26  
27  /**
28   * {@link ChannelException} which holds {@link ChannelFuture}s that failed because of an error.
29   */
30  public class ChannelGroupException extends ChannelException implements Iterable<Map.Entry<Channel, Throwable>> {
31      private static final long serialVersionUID = -4093064295562629453L;
32      private final Collection<Map.Entry<Channel, Throwable>> failed;
33  
34      public ChannelGroupException(Collection<Map.Entry<Channel, Throwable>> causes) {
35          if (causes == null) {
36              throw new NullPointerException("causes");
37          }
38          if (causes.isEmpty()) {
39              throw new IllegalArgumentException("causes must be non empty");
40          }
41          failed = Collections.unmodifiableCollection(causes);
42      }
43  
44      /**
45       * Returns a {@link Iterator} which contains all the {@link Throwable} that was a cause of the failure and the
46       * related id of the {@link Channel}.
47       */
48      @Override
49      public Iterator<Map.Entry<Channel, Throwable>> iterator() {
50          return failed.iterator();
51      }
52  }