001package votorola.g.util.concurrent; // Copyright 2007, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import java.util.concurrent.*;
004
005
006/** An extended CountDownLatch, and CountDownLatch utilities.
007  */
008public final class CountDownLatchX extends CountDownLatch
009{
010
011
012    public CountDownLatchX( int count ) { super( count ); }
013
014
015
016   // ------------------------------------------------------------------------------------
017
018
019    /** Same as {@linkplain Thread#join() join}(), but returns normally if interrupted.
020      *
021      *     @return true if the wait ended normally; false if an InterruptedException occured
022      */
023    public boolean tryAwait( long timeout, TimeUnit unit )
024    {
025        return tryAwait( CountDownLatchX.this, timeout, unit );
026    }
027
028
029
030        /** Same as {@linkplain CountDownLatch#await(long,TimeUnit) await}(),
031          * but returns normally if interrupted.
032          * Interrupt state (was it interrupted or not?) is lost.
033          *
034          *     @return true if the count reached zero; false otherwise
035          */
036        public static boolean tryAwait( CountDownLatch latch, long timeout, TimeUnit unit )
037        {
038            try
039            {
040                return latch.await( timeout, unit );
041            }
042            catch( InterruptedException x ) { return latch.getCount() == 0; }
043        }
044
045
046
047}