org.openbase.jul.extension.protobuf

Class MessageObservable<M extends com.google.protobuf.Message>

java.lang.Object

org.openbase.jul.pattern.AbstractObservable<M>

org.openbase.jul.extension.protobuf.MessageObservable<M>

Type Parameters:

M - the type which is notified by this observable

All Implemented Interfaces:

Shutdownable, org.openbase.jul.pattern.Observable<M>

public class MessageObservable<M extends com.google.protobuf.Message>
extends org.openbase.jul.pattern.AbstractObservable<M>

This class computes the hashCode to check if the observed value has changed invariant of its timestamp. Currently for efficiency reasons the timestamp of messages in repeated fields is still considered.

Author:

Tamino Huxohl

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_ALLOCATION_FIELD
static String	TIMESTAMP_MESSAGE_NAME

Fields inherited from class org.openbase.jul.pattern.AbstractObservable

latestValueHash, NOTIFICATION_LOCK, observers, unchangedValueFilter

Constructor Summary

Constructors

Constructor and Description
MessageObservable(org.openbase.jul.pattern.provider.DataProvider<M> source)

Method Summary

Modifier and Type	Method and Description
M	getValue()
Future<M>	getValueFuture()
boolean	isValueAvailable()
com.google.protobuf.Message.Builder	removeTimestamps(com.google.protobuf.Message.Builder builder)
void	waitForValue(long timeout, TimeUnit timeUnit)

Methods inherited from class org.openbase.jul.pattern.AbstractObservable

addObserver, applyValueUpdate, isNotificationInProgess, notifyObservers, notifyObservers, removeObserver, setExecutorService, setHashGenerator, shutdown, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.jul.pattern.Observable

getLatestValue, waitForValue

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Field Detail

TIMESTAMP_MESSAGE_NAME

public static final String TIMESTAMP_MESSAGE_NAME

See Also:

Constant Field Values

RESOURCE_ALLOCATION_FIELD

public static final String RESOURCE_ALLOCATION_FIELD

See Also:

Constant Field Values

Constructor Detail

MessageObservable

public MessageObservable(org.openbase.jul.pattern.provider.DataProvider<M> source)

Method Detail

waitForValue

public void waitForValue(long timeout,
                         TimeUnit timeUnit)
                  throws CouldNotPerformException,
                         InterruptedException

Throws:

CouldNotPerformException

InterruptedException

getValue

public M getValue()
           throws NotAvailableException

Throws:

NotAvailableException

isValueAvailable

public boolean isValueAvailable()

getValueFuture

public Future<M> getValueFuture()

removeTimestamps

public com.google.protobuf.Message.Builder removeTimestamps(com.google.protobuf.Message.Builder builder)