View Javadoc
1 /*** 2 * Redistribution and use of this software and associated documentation 3 * ("Software"), with or without modification, are permitted provided 4 * that the following conditions are met: 5 * 6 * 1. Redistributions of source code must retain copyright 7 * statements and notices. Redistributions must also contain a 8 * copy of this document. 9 * 10 * 2. Redistributions in binary form must reproduce the 11 * above copyright notice, this list of conditions and the 12 * following disclaimer in the documentation and/or other 13 * materials provided with the distribution. 14 * 15 * 3. The name "Exolab" must not be used to endorse or promote 16 * products derived from this Software without prior written 17 * permission of Exoffice Technologies. For written permission, 18 * please contact tma@netspace.net.au. 19 * 20 * 4. Products derived from this Software may not be called "Exolab" 21 * nor may "Exolab" appear in their names without prior written 22 * permission of Exoffice Technologies. Exolab is a registered 23 * trademark of Exoffice Technologies. 24 * 25 * 5. Due credit should be given to the Exolab Project 26 * (http://www.exolab.org/). 27 * 28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 39 * OF THE POSSIBILITY OF SUCH DAMAGE. 40 * 41 * Copyright 2003-2004 (C) Exoffice Technologies Inc. All Rights Reserved. 42 * 43 * $Id: CompletionListener.java,v 1.4 2004/01/31 13:44:24 tanderson Exp $ 44 */ 45 package org.exolab.jmscts.core; 46 47 import EDU.oswego.cs.dl.util.concurrent.Semaphore; 48 49 50 /*** 51 * Helper class to synchronize on the completion of tasks 52 * 53 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a> 54 * @version $Revision: 1.4 $ 55 * @see DelayedAction 56 */ 57 public class CompletionListener { 58 59 /*** 60 * The number of tasks expected to complete 61 */ 62 private int _expected; 63 64 /*** 65 * Semaphore used to synchronize process completion 66 */ 67 private Semaphore _completedLock; 68 69 70 /*** 71 * Construct a new <code>CompletionListener</code> 72 * 73 * @param expected the number of tasks expected to complete 74 */ 75 public CompletionListener(int expected) { 76 _expected = expected; 77 _completedLock = new Semaphore(-expected + 1); 78 } 79 80 /*** 81 * Notify completion of a task 82 */ 83 public void completed() { 84 _completedLock.release(); 85 } 86 87 /*** 88 * Wait for the listener to complete processing 89 * 90 * @param timeout the number of milleseconds to wait. An argument less 91 * than or equal to zero means not to wait at all 92 * @throws InterruptedException if interrupted while waiting 93 * @return <code>true</code> if the listener completed in the given time 94 * frame 95 */ 96 public boolean waitForCompletion(long timeout) 97 throws InterruptedException { 98 boolean completed = _completedLock.attempt(timeout); 99 if (completed) { 100 _completedLock.release(); 101 } 102 return completed; 103 } 104 105 /*** 106 * Wait indefinitely for the tasks to complete processing 107 * 108 * @throws InterruptedException if interrupted while waiting 109 */ 110 public void waitForCompletion() throws InterruptedException { 111 _completedLock.acquire(); 112 _completedLock.release(); 113 } 114 115 /*** 116 * Returns the number of completed tasks 117 * 118 * @return the number of completed tasks 119 */ 120 public int getCompleted() { 121 return _expected + (int) _completedLock.permits() - 1; 122 } 123 124 }

This page was automatically generated by Maven