org.flexiblepower.observation.ext

Class AbstractObservationProvider<T>

java.lang.Object

org.flexiblepower.observation.ext.AbstractObservationProvider<T>

Type Parameters:

T - The type of the value

All Implemented Interfaces:

ObservationProvider<T>

Direct Known Subclasses:

SimpleObservationProvider

public abstract class AbstractObservationProvider<T>
extends java.lang.Object
implements ObservationProvider<T>

Gives a basic implementation of an ObservationProvider where the subscribe(ObservationConsumer) and unsubscribe(ObservationConsumer) methods are implemented. To publish a new observation, the publish(Observation) method should be used.

Constructor Summary

Constructors

Constructor and Description
AbstractObservationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
Observation<? extends T>	getLastObservation() Get the last published Observation.
void	publish(Observation<? extends T> observation) Publishes an observation to all the subscribed consumers.
void	subscribe(ObservationConsumer<? super T> consumer) Binds the consumer to this provider.
void	unsubscribe(ObservationConsumer<? super T> consumer) Unbinds the consumer from this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractObservationProvider

public AbstractObservationProvider()

Method Detail

subscribe

public void subscribe(ObservationConsumer<? super T> consumer)

Description copied from interface: ObservationProvider

Binds the consumer to this provider. After this call has returned, all the observations produced by the provider should be sent to this consumer via its ObservationConsumer.consume(ObservationProvider, Observation) method.

Specified by:

subscribe in interface ObservationProvider<T>

Parameters:

consumer - The ObservationConsumer that will be bound to this provider.

unsubscribe

public void unsubscribe(ObservationConsumer<? super T> consumer)

Description copied from interface: ObservationProvider

Unbinds the consumer from this provider. After this call has returned, the observations must no longer be sent to the consumer.

Specified by:

unsubscribe in interface ObservationProvider<T>

Parameters:

consumer - The ObservationConsumer that will be unbound from this provider.

getLastObservation

public Observation<? extends T> getLastObservation()

Description copied from interface: ObservationProvider

Get the last published Observation.

Specified by:

getLastObservation in interface ObservationProvider<T>

Returns:

The last published observation, or null when no observation has been published yet.

publish

public void publish(Observation<? extends T> observation)

Publishes an observation to all the subscribed consumers.

Parameters:

observation - The observation that will be sent.