View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.core.future;
21  
22  import java.util.concurrent.atomic.AtomicInteger;
23  
24  import org.apache.mina.core.IoUtil;
25  
26  /**
27   * An {@link IoFuture} of {@link IoFuture}s.  It is useful when you want to
28   * get notified when all {@link IoFuture}s are complete.  It is not recommended
29   * to use {@link CompositeIoFuture} if you just want to wait for all futures.
30   * In that case, please use {@link IoUtil#await(Iterable)} instead
31   * for better performance.
32   * 
33   * @author The Apache MINA Project (dev@mina.apache.org)
34   * @version $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $
35   *
36   * @param <E> the type of the child futures.
37   */
38  public class CompositeIoFuture<E extends IoFuture> extends DefaultIoFuture {
39      
40      private final NotifyingListener listener = new NotifyingListener();
41      private final AtomicInteger unnotified = new AtomicInteger();
42      private volatile boolean constructionFinished;
43      
44      public CompositeIoFuture(Iterable<E> children) {
45          super(null);
46          
47          for (E f: children) {
48              f.addListener(listener);
49              unnotified.incrementAndGet();
50          }
51          
52          constructionFinished = true;
53          if (unnotified.get() == 0) {
54              setValue(true);
55          }
56      }
57      
58      private class NotifyingListener implements IoFutureListener<IoFuture> {
59          public void operationComplete(IoFuture future) {
60              if (unnotified.decrementAndGet() == 0 && constructionFinished) {
61                  setValue(true);
62              }
63          }
64      }
65  }