com.luciad.utils

Class Observable<T>

java.lang.Object

com.luciad.utils.Observable<T>

Type Parameters:

T - the type to hold

public class Observable<T>
extends Object

This class makes it possible to hold and observe a value that can change over time.

Constructor Summary

Constructors

Constructor and Description
Observable(T initialValue, Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
void	addCallback(IInvalidationCallback callback) Adds a callback that is notified when setValue is called.
static <T> Observable<T>	create(T initialValue) Creates a new Observable with the given initial value.
static <T> Observable<T>	create(T initialValue, Class<T> clazz)
T	getValue() Returns the observable value.
void	removeCallback(IInvalidationCallback callback) Remove the given callback.
void	setValue(T value) Sets the observable value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Observable

public Observable(T initialValue,
                  @NotNull
                  Class<T> clazz)

Method Detail

create

@NotNull
public static <T> Observable<T> create(T initialValue)

Creates a new Observable with the given initial value.

Parameters:

initialValue - the initial value.

create

@NotNull
public static <T> Observable<T> create(T initialValue,
                                                @NotNull
                                                Class<T> clazz)

getValue

public T getValue()

Returns the observable value.

Returns:

the observable value.

setValue

public void setValue(T value)
              throws IllegalStateException

Sets the observable value.

This triggers a call to the configured callbacks.

Parameters:

value - the new value

Throws:

IllegalStateException - when calling setValue on derived instances for example.

addCallback

public void addCallback(@NotNull
                        IInvalidationCallback callback)
                 throws IllegalArgumentException

Adds a callback that is notified when setValue is called.

Parameters:

callback - a callback

Throws:

IllegalArgumentException - when the call back is already added.

removeCallback

public void removeCallback(@NotNull
                           IInvalidationCallback callback)
                    throws IllegalArgumentException

Remove the given callback.

Parameters:

callback - a callback

Throws:

IllegalArgumentException - when the call back is not known.