Class AwaitableCounter

java.lang.Object

org.jdrupes.builder.core.AwaitableCounter

public class AwaitableCounter
extends Object

A counter that supports waiting for a specific value. The waiting thread is woken when the counter hits the target value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AwaitableCounter.Increment	Increment/decrement with an AutoCloseable.

Constructor Summary

Constructors

Constructor	Description
AwaitableCounter()	Initializes a new awaitable counter.

Method Summary

Modifier and Type	Method	Description
AwaitableCounter.Increment	acquire()	Create an increment.
AwaitableCounter	await(int wanted)	Wait for the counter to reach the given value.
AwaitableCounter	decrement()	Decrement the counter's value.
AwaitableCounter	increment()	Increment the count's value.
int	value()	Return the counter's value.

Methods inherited from class Object

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

Constructor Details

AwaitableCounter

public AwaitableCounter()

Initializes a new awaitable counter.

Method Details

increment

public AwaitableCounter increment()

Increment the count's value.

Returns:

the counter

decrement

public AwaitableCounter decrement()

Decrement the counter's value.

Returns:

the counter

value

public int value()

Return the counter's value.

Returns:

the value

acquire

public AwaitableCounter.Increment acquire()

Create an increment.

Returns:

the count

await

public AwaitableCounter await(int wanted)
                       throws InterruptedException

Wait for the counter to reach the given value.

Parameters:

wanted - the wanted

Returns:

the counter

Throws:

InterruptedException - the interrupted exception