cz.cuni.amis.pogamut.base.communication.worldview

Interface ILockableWorldView

All Superinterfaces:

IComponent, IWorldChangeEventInput, IWorldView

All Known Subinterfaces:

ILockableVisionWorldView

All Known Implementing Classes:

LocalWorldViewAdapter, LockableBatchAwareWorldView, LockableWorldView, SyncLockableBatchAwareWorldView

public interface ILockableWorldView
extends IWorldView

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isLocked() Whether the worldview is locked.
void	lock() Lock the worldview, preventing it from raising any new events.
void	unlock() Unlock the worldview, processing all events that came between lock() / unlock() calls.

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.worldview.IWorldView

addEventListener, addObjectListener, addObjectListener, addObjectListener, addObjectListener, get, get, get, getAll, getAll, getEventBus, getSingle, isListening, isListening, isListening, isListening, isListening, isListening, removeEventListener, removeListener, removeObjectListener, removeObjectListener, removeObjectListener, removeObjectListener

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.worldview.IWorldChangeEventInput

notify, notifyAfterPropagation, notifyImmediately

Methods inherited from interface cz.cuni.amis.pogamut.base.component.IComponent

getComponentId

Method Detail

lock

void lock()
          throws cz.cuni.amis.utils.exception.PogamutInterruptedException,
                 ComponentNotRunningException,
                 ComponentPausedException

Lock the worldview, preventing it from raising any new events.

When locked - the worldview must store all incoming events and process them during unlock.

Note that it is implementation-dependent whether this method is blocking or not.

Throws:

cz.cuni.amis.utils.exception.PogamutInterruptedException

ComponentNotRunningException

ComponentPausedException

unlock

void unlock()
            throws ComponentNotRunningException,
                   ComponentPausedException

Unlock the worldview, processing all events that came between lock() / unlock() calls.

Throws:

ComponentNotRunningException

ComponentPausedException

isLocked

boolean isLocked()

Whether the worldview is locked.

Returns: