net.tridentsdk.concurrent

Class HeldValueLatch<V>

java.lang.Object

net.tridentsdk.concurrent.HeldValueLatch<V>

Type Parameters:

V - the value type of the latch

@ThreadSafe
public class HeldValueLatch<V>
extends Object

A one-time latch that holds a value

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
V	await() Acquires the value held be the latch, or blocks to wait for the value to become available
V	countDown(V value) Sets the value in the latch
static <V> HeldValueLatch<V>	create() Creates a new latch that can hold a value
V	get() Acquires the value without waiting for the latch to be counted down
boolean	hasValue() Inspects the latch to find of the object has been counted down

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <V> HeldValueLatch<V> create()

Creates a new latch that can hold a value

Type Parameters:

V - the type of the value

Returns:

a new value latch

countDown

public V countDown(V value)

Sets the value in the latch

The effects of setting this only once is unspecified

This is unsynchronized because all actions prior to counting down happens-before another thread awaits the value

Parameters:

value - the value to set to the latch

Returns:

the value passed in

hasValue

public boolean hasValue()

Inspects the latch to find of the object has been counted down

Returns:

true if the value has been set

await

public V await()
        throws InterruptedException

Acquires the value held be the latch, or blocks to wait for the value to become available

Returns:

the value held by the latch

Throws:

InterruptedException - if the operation was interrupted while blocked

get

public V get()

Acquires the value without waiting for the latch to be counted down

This is still thread-safe, as the internal state is volatile

Returns:

the value held by this latch