org.jowidgets.util

Class FutureValue<VALUE_TYPE>

java.lang.Object

org.jowidgets.util.FutureValue<VALUE_TYPE>

All Implemented Interfaces:

IFutureValue<VALUE_TYPE>

public final class FutureValue<VALUE_TYPE>
extends java.lang.Object
implements IFutureValue<VALUE_TYPE>

Constructor Summary

Constructors

Constructor and Description
FutureValue()
FutureValue(VALUE_TYPE value)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFutureCallback(IFutureValueCallback<VALUE_TYPE> callback) Adds a callback that will be invoked in the following manner: 1.
VALUE_TYPE	getValue() Gets the value if the future is initialized and throw a runtime exception otherwise
void	initialize(VALUE_TYPE value) Initializes the future with a defined value.
boolean	isInitialized()
void	removeFutureCallback(IFutureValueCallback<VALUE_TYPE> callback) Removes a creation callback if no longer interested on the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureValue

public FutureValue()

FutureValue

public FutureValue(VALUE_TYPE value)

Method Detail

addFutureCallback

public void addFutureCallback(IFutureValueCallback<VALUE_TYPE> callback)

Description copied from interface: IFutureValue

Adds a callback that will be invoked in the following manner: 1. If the value is already initialized, the given callback will be invoked immediately 2. If the value was not already initialized, the given callback will be invoked later but immediately after the value was initialized Remark: After the initialize method was invoked on the callback, the callback reference will be cleared automatically on this future, because a future value can not be initialized twice. Clients of this interface may not remove the callback for initialized values manually

Specified by:

addFutureCallback in interface IFutureValue<VALUE_TYPE>

Parameters:

callback - The callback that gets the initialized value

removeFutureCallback

public void removeFutureCallback(IFutureValueCallback<VALUE_TYPE> callback)

Description copied from interface: IFutureValue

Removes a creation callback if no longer interested on the value.

Specified by:

removeFutureCallback in interface IFutureValue<VALUE_TYPE>

Parameters:

callback - The callback to remove

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface IFutureValue<VALUE_TYPE>

Returns:

True if the value was already initialized, false otherwise

getValue

public VALUE_TYPE getValue()

Description copied from interface: IFutureValue

Gets the value if the future is initialized and throw a runtime exception otherwise

Specified by:

getValue in interface IFutureValue<VALUE_TYPE>

Returns:

The value of the future if initialized (may be null)

initialize

public void initialize(VALUE_TYPE value)

Initializes the future with a defined value. This can only be done once.

Parameters:

value - The value to initialize the future with, may be null

Throws:

java.lang.IllegalStateException - if the future was already initialized