com.yworks.yfiles.utils

Class Future<T>

java.lang.Object

com.yworks.yfiles.utils.Future<T>

Type Parameters:

T - The type of the Value

public final class Future<T>
extends Object

A helper holder class that can contain a Value of a specific type.

Typically HasValue will be false until at a later point in time onValueDetermined(java.lang.Object) is called and the Value and HasValue properties are being updated and the PropertyChanged event is triggered.

Constructor Summary

Constructors

Constructor and Description
Future()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Adds the given listener for the PropertyChanged event that occurs when a property value changes.
T	getValue() The value of this future, which may only be queried if HasValue yields true.
boolean	hasValue() Gets a value indicating whether this instance has been assigned a Value.
void	onValueDetermined(T value) Called when the Value property of this future has been determined.
void	removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Removes the given listener for the PropertyChanged event that occurs when a property value changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Future

public Future()

Method Detail

addPropertyChangedListener

public final void addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Adds the given listener for the PropertyChanged event that occurs when a property value changes.

This event will be triggered for HasValue changes and changes of the Value property. Note that if the determined future value is the same as the default, the event will only be triggered for the HasValue property.

Parameters:

propertyChangedEvent - The listener to add.

See Also:

removePropertyChangedListener(IEventHandler)

getValue

public final T getValue()

The value of this future, which may only be queried if HasValue yields true.

Throws:

IllegalStateException - If this property is queried although HasValue returns false.

Returns:

The Value.

hasValue

public final boolean hasValue()

Gets a value indicating whether this instance has been assigned a Value.

Returns:

true if this instance has been assigned a value; false otherwise.

onValueDetermined

public final void onValueDetermined(T value)

Called when the Value property of this future has been determined.

This will set the HasValue property to true and assign the Value property. Also the corresponding PropertyChanged events will be triggered if necessary.

Parameters:

value - The value.

removePropertyChangedListener

public final void removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Removes the given listener for the PropertyChanged event that occurs when a property value changes.

This event will be triggered for HasValue changes and changes of the Value property. Note that if the determined future value is the same as the default, the event will only be triggered for the HasValue property.

Parameters:

propertyChangedEvent - The listener to remove.

See Also:

addPropertyChangedListener(IEventHandler)