Package com.oracle.coherence.concurrent

Class LocalCountDownLatch

java.lang.Object

com.oracle.coherence.concurrent.LocalCountDownLatch

All Implemented Interfaces:

CountDownLatch

public class LocalCountDownLatch
extends Object
implements CountDownLatch

Local implementation of CountDownLatch interface, that simply wraps java.util.concurrent.CountDownLatch instance.

Author:

Aleks Seovic 2021.12.05

Method Summary

Modifier and Type	Method	Description
void	await()	Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted.
boolean	await(long timeout, TimeUnit unit)	Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted, or the specified waiting time elapses.
void	countDown()	Decrements the count of the latch, releasing all waiting threads if the count reaches zero.
long	getCount()	Returns the current count.
String	toString()	Returns a string identifying this latch, as well as its state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

await

public void await()
           throws InterruptedException

Description copied from interface: CountDownLatch

Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted.

If the current count is zero then this method returns immediately.

If the current count is greater than zero then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happen:

• The count reaches zero due to invocations of the CountDownLatch.countDown() method; or
• Some other thread interrupts the current thread.

If the current thread:

• has its interrupted status set on entry to this method; or
• is interrupted while waiting,

then InterruptedException is thrown and the current thread's interrupted status is cleared.

Specified by:

await in interface CountDownLatch

Throws:

InterruptedException - if the current thread is interrupted while waiting

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Description copied from interface: CountDownLatch

Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted, or the specified waiting time elapses.

If the current count is zero then this method returns immediately with the value true.

If the current count is greater than zero then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happen:

• The count reaches zero due to invocations of the CountDownLatch.countDown() method; or
• Some other thread interrupts the current thread; or
• The specified waiting time elapses.

If the count reaches zero then the method returns with the value true.

If the current thread:

• has its interrupted status set on entry to this method; or
• is interrupted while waiting,

then InterruptedException is thrown and the current thread's interrupted status is cleared.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Specified by:

await in interface CountDownLatch

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if the count reached zero and false if the if the waiting time elapsed before the count reached zero

Throws:

InterruptedException - if the current thread is interrupted while waiting

countDown

public void countDown()

Description copied from interface: CountDownLatch

Decrements the count of the latch, releasing all waiting threads if the count reaches zero.

If the current count is greater than zero then it is decremented. If the new count is zero then all waiting threads are re-enabled for thread scheduling purposes.

If the current count equals zero then nothing happens.

Specified by:

countDown in interface CountDownLatch

getCount

public long getCount()

Description copied from interface: CountDownLatch

Returns the current count.

This method is typically used for debugging and testing purposes.

Specified by:

getCount in interface CountDownLatch

Returns:

the current count

toString

public String toString()

Returns a string identifying this latch, as well as its state. The state, in brackets, includes the String "Count =" followed by the current count.

Overrides:

toString in class Object

Returns:

a string identifying this latch, as well as its state