io.induct.util.concurrent

Class SyncValue<V>

java.lang.Object

io.induct.util.concurrent.SyncValue<V>

Type Parameters:

V - Type of the wrapped value

public class SyncValue<V>
extends java.lang.Object

Async-to-sync value helper. Also can be considered to be a single-item blocking producer-consumer abstraction.

Since:

15.2.2015

Constructor Summary

Constructors

Constructor and Description
SyncValue()

Method Summary

Modifier and Type	Method and Description
V	get() Get the value.
boolean	isAssigned() Check if a value has been assigned.
void	push(V value) Provide any value for the consumer(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncValue

public SyncValue()

Method Detail

push

public void push(V value)

Provide any value for the consumer(s).

Parameters:

value - Value to publish. Any value is accepted.

See Also:

get()

get

public V get()

Get the value. This method will block until value is being made available with push(Object) or the underlying latch is interrupted. There is no timeout involved making this method potentially hazardous if value is never provided.

Returns:

Value produced by calling push(Object)

Throws:

HaltedException - Thrown if value cannot be acquired.

isAssigned

public boolean isAssigned()

Check if a value has been assigned. This can be used externally to avoid publishing multiple values and thus accidentally overriding the original intended value.

Returns:

true if value has been assigned, false otherwise