org.openbase.jul.storage.registry

Interface ConsistencyHandler<KEY,VALUE extends Identifiable<KEY>,MAP extends Map<KEY,VALUE>,R extends Registry<KEY,VALUE>>

Type Parameters:

KEY - the registry key type.

VALUE - the registry data value type.

MAP -

R -

All Superinterfaces:

Shutdownable

All Known Subinterfaces:

ProtoBufRegistryConsistencyHandler<KEY,M,MB,REGISTRY>

All Known Implementing Classes:

AbstractConsistencyHandler, AbstractProtoBufRegistryConsistencyHandler, AbstractVersionConsistencyHandler

public interface ConsistencyHandler<KEY,VALUE extends Identifiable<KEY>,MAP extends Map<KEY,VALUE>,R extends Registry<KEY,VALUE>>
extends Shutdownable

Author:

Divine Threepwood ConsistencyHandler can be registered at any registry type and will be informed about data changes via the processData Method. The handler can be used to establish a registry data consistency.

Nested Class Summary

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

Shutdownable.ShutdownDeamon

Method Summary

Modifier and Type	Method and Description
void	processData(KEY id, VALUE entry, MAP entryMap, R registry) Method for establishing a registry data consistency.
void	reset() Method can be internally used to clear any temporally maps or other caches which are only used for one consistency check iteration.

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

registerShutdownHook, registerShutdownHook, shutdown

Method Detail

processData

void processData(KEY id,
                 VALUE entry,
                 MAP entryMap,
                 R registry)
          throws CouldNotPerformException,
                 EntryModification

Method for establishing a registry data consistency. Method is called by the registry in case of entry changes.

Parameters:

id -

entry -

entryMap - the entry map of the underlying registry.

registry - the underlying registry.

Throws:

CouldNotPerformException - thrown to handle errors.

EntryModification - in case of entry modification during consistency process.

reset

void reset()

Method can be internally used to clear any temporally maps or other caches which are only used for one consistency check iteration. This method is called each time the registry consistency check starts a new iteration. In some cases it makes sense to cache any properties e.g. scopes or ids which should be globally unique. This check can be performed by caching these values within a map. To make sure these maps do not interfere between different consistency check iterations this method can be used to clear these kind of caches.