org.openbase.jul.storage.registry

Interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Type Parameters:

KEY -

ENTRY -

All Superinterfaces:

NameProvider, org.openbase.jul.pattern.Observable<Map<KEY,ENTRY>>, Shutdownable, Writable

All Known Subinterfaces:

FileSynchronizedRegistry<KEY,VALUE>, ProtoBufRegistry<KEY,M,MB>, RegistrySandbox<KEY,ENTRY,MAP,REGISTRY>, SynchronizableRegistry<KEY,ENTRY>

All Known Implementing Classes:

AbstractRegistry, ControllerRegistryImpl, FileSynchronizedRegistryImpl, FileSynchronizedRegistrySandbox, MockRegistrySandbox, ProtoBufFileSynchronizedRegistry, ProtoBufFileSynchronizedRegistrySandbox, RegistryImpl, RegistrySandboxImpl, RemoteControllerRegistry, RemoteControllerRegistryImpl, RemoteRegistry, RemoteRegistryImpl, SynchronizableRegistryImpl

public interface Registry<KEY,ENTRY extends Identifiable<KEY>>
extends Writable, org.openbase.jul.pattern.Observable<Map<KEY,ENTRY>>, NameProvider

Author:

Divine Threepwood

Nested Class Summary

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

Shutdownable.ShutdownDeamon

Field Summary

Fields inherited from interface org.openbase.jul.iface.provider.NameProvider

TYPE_FIELD_NAME

Method Summary

Modifier and Type	Method and Description
void	addDependencyObserver(org.openbase.jul.pattern.Observer<Map<KEY,ENTRY>> observer)
void	clear()
boolean	contains(ENTRY entry)
boolean	contains(KEY key)
default ENTRY	get(ENTRY entry)
ENTRY	get(KEY key)
List<ENTRY>	getEntries() Copies all entries into a list.
Map<KEY,ENTRY>	getEntryMap() An unmodifiable map of the current entry map.
String	getName() Method returns the name of this registry.
boolean	isConsistent()
boolean	isEmpty() Return true if this registry does not contain any entries.
default boolean	isEmtpy() Deprecated. since 1.3: removed because of typo. Please use isEmpty() instead!
boolean	isReadOnly()
boolean	isReady() This method checks if the registry is not handling any tasks or notification and is currently consistent.
boolean	isSandbox()
boolean	recursiveTryLockRegistry(Set<Registry> lockedRegistries) Try to acquire the write lock for this registry and the registries it depends on recursively.
ENTRY	register(ENTRY entry) Method registers the given entry.
ENTRY	remove(ENTRY entry)
ENTRY	remove(KEY key)
void	removeDependencyObserver(org.openbase.jul.pattern.Observer<Map<KEY,ENTRY>> observer)
int	size() Method returns the amount of registry entries.
boolean	tryLockRegistry() Try to acquire the write lock for this registry.
void	unlockRegistry() Unlock the write lock of the registry.
ENTRY	update(ENTRY entry)

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

checkWriteAccess, isWritable

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

addObserver, getLatestValue, getValue, getValueFuture, isValueAvailable, removeObserver, waitForValue, waitForValue

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

registerShutdownHook, registerShutdownHook, shutdown

Method Detail

getName

String getName()
        throws NotAvailableException

Method returns the name of this registry.

Specified by:

getName in interface NameProvider

Returns:

the name as string.

Throws:

NotAvailableException - is thrown if the name is not available.

register

ENTRY register(ENTRY entry)
        throws CouldNotPerformException

Method registers the given entry.

Parameters:

entry - the new entry to register which is not yet included in the registry

Returns:

the registered entry updated by all consistency checks this registry provides.

Throws:

CouldNotPerformException - is thrown if the given entry is not valid, already registered or something else went wrong during the registration.

update

ENTRY update(ENTRY entry)
      throws CouldNotPerformException

Throws:

CouldNotPerformException

remove

ENTRY remove(KEY key)
      throws CouldNotPerformException

Throws:

CouldNotPerformException

remove

ENTRY remove(ENTRY entry)
      throws CouldNotPerformException

Throws:

CouldNotPerformException

get

ENTRY get(KEY key)
   throws CouldNotPerformException

Throws:

CouldNotPerformException

get

default ENTRY get(ENTRY entry)
           throws CouldNotPerformException

Throws:

CouldNotPerformException

getEntries

List<ENTRY> getEntries()
                throws CouldNotPerformException

Copies all entries into a list.

Returns:

a list with all values of the entry map

Throws:

CouldNotPerformException - if something fails

getEntryMap

Map<KEY,ENTRY> getEntryMap()

An unmodifiable map of the current entry map.

Returns:

the current entry map of the registry but unmodifiable

contains

boolean contains(ENTRY entry)
          throws CouldNotPerformException

Throws:

CouldNotPerformException

contains

boolean contains(KEY key)
          throws CouldNotPerformException

Throws:

CouldNotPerformException

clear

void clear()
    throws CouldNotPerformException

Throws:

CouldNotPerformException

size

int size()

Method returns the amount of registry entries.

Returns:

the count of entries as integer.

isReadOnly

boolean isReadOnly()

isConsistent

boolean isConsistent()

isSandbox

boolean isSandbox()

isReady

boolean isReady()

This method checks if the registry is not handling any tasks or notification and is currently consistent.

Returns:

Returns true if this registry is consistent and not busy.

isEmpty

boolean isEmpty()

Return true if this registry does not contain any entries.

Returns:

is true if the registry is empty.

isEmtpy

@Deprecated
default boolean isEmtpy()

Deprecated. since 1.3: removed because of typo. Please use isEmpty() instead!

Return true if this registry does not contain any entries.

Returns:

is true if the registry is empty.

tryLockRegistry

boolean tryLockRegistry()
                 throws RejectedException

Try to acquire the write lock for this registry. If this method returns true then this thread now holds the write lock for this registry. If it returns false then the lock could not currently be acquired.

Returns:

If the lock could be acquired.

Throws:

RejectedException - If the registry does not support to be locked externally which is for example the case for remote registries.

recursiveTryLockRegistry

boolean recursiveTryLockRegistry(Set<Registry> lockedRegistries)
                          throws RejectedException

Try to acquire the write lock for this registry and the registries it depends on recursively. This method returns true if all locks could be acquired and false if at least one lock could not be acquired. In any case the set lockedRegistries contains any locked registry afterwards. So if the method returns false any registry inside this set should be unlocked before trying it again to prevent dead locks. Additionally this method should only be performed while already holding the write lock for the registry. Else it can happen that a thread that tries to recursively lock the same registry by using the same set as another thread thinks that he acquired it even though the other thread is currently in the process of acquiring it.

Parameters:

lockedRegistries - Set of already locked registries. Should be given empty to this method and will contain all locked registries afterwards.

Returns:

If all registries could be locked.

Throws:

RejectedException - If the registry does not support to be locked externally which is for example the case for remote registries.

unlockRegistry

void unlockRegistry()

Unlock the write lock of the registry.

addDependencyObserver

void addDependencyObserver(org.openbase.jul.pattern.Observer<Map<KEY,ENTRY>> observer)

removeDependencyObserver

void removeDependencyObserver(org.openbase.jul.pattern.Observer<Map<KEY,ENTRY>> observer)