org.openbase.jul.storage.registry

Class RegistrySandboxImpl<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

java.lang.Object

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

org.openbase.jul.pattern.ObservableImpl<Map<KEY,ENTRY>>

org.openbase.jul.storage.registry.AbstractRegistry<KEY,ENTRY,MAP,R,P>

org.openbase.jul.storage.registry.RegistrySandboxImpl<KEY,ENTRY,MAP,R,P>

Type Parameters:

KEY -

ENTRY -

MAP -

R -

P -

All Implemented Interfaces:

NameProvider, Shutdownable, Writable, org.openbase.jul.pattern.Observable<Map<KEY,ENTRY>>, Registry<KEY,ENTRY>, RegistrySandbox<KEY,ENTRY,MAP,R>

Direct Known Subclasses:

FileSynchronizedRegistrySandbox

public class RegistrySandboxImpl<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>
extends AbstractRegistry<KEY,ENTRY,MAP,R,P>
implements RegistrySandbox<KEY,ENTRY,MAP,R>

Author:

Divine Threepwood

Nested Class Summary

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

Shutdownable.ShutdownDeamon

Field Summary

Fields inherited from class org.openbase.jul.storage.registry.AbstractRegistry

consistent, logger, pluginPool, sandbox

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

VALUE_LOCK

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

latestValueHash, observers, unchangedValueFilter

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

TYPE_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
RegistrySandboxImpl(MAP entryMap, R originRegistry)
RegistrySandboxImpl(MAP entryMap, RegistryCloner<KEY,ENTRY,MAP> cloner, R originRegistry)

Method Summary

Modifier and Type	Method and Description
void	addObserver(org.openbase.jul.pattern.Observer<Map<KEY,ENTRY>> observer)
protected void	finishTransaction()
boolean	isSandbox()
ENTRY	register(ENTRY entry) Method registers the given entry.
void	replaceInternalMap(Map<KEY,ENTRY> map, boolean finishTransaction) Replaces the internal registry map by the given one.
ENTRY	superRemove(ENTRY entry)
void	sync(MAP map)
String	toString()
ENTRY	update(ENTRY entry)

Methods inherited from class org.openbase.jul.storage.registry.AbstractRegistry

addDependencyObserver, afterConsistencyCheck, checkConsistency, checkWriteAccess, clear, contains, contains, get, getEntries, getEntryMap, getEntryMapClass, getName, info, isBusy, isBusyByCurrentThread, isConsistent, isDependingOnConsistentRegistries, isEmpty, isReadOnly, isReady, isWriteLockedByCurrentThread, load, lock, log, log, log, notifyObservers, recursiveTryLockRegistry, registerConsistencyHandler, registerDependency, registerPlugin, remove, remove, removeAllDependencies, removeConsistencyHandler, removeDependency, removeDependencyObserver, replaceInternalMap, setName, setupSandbox, shutdown, size, tryLockRegistry, unlock, unlockRegistry, verifyID, verifyID

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

applyValueUpdate, getValue, getValueFuture, isValueAvailable, waitForValue

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

isNotificationInProgess, notifyObservers, notifyObservers, removeObserver, setExecutorService, setHashGenerator, waitUntilNotificationIsFinished

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.jul.storage.registry.RegistrySandbox

load, registerConsistencyHandler, removeConsistencyHandler, replaceInternalMap

Methods inherited from interface org.openbase.jul.storage.registry.Registry

addDependencyObserver, clear, contains, contains, get, get, getEntries, getEntryMap, getName, isConsistent, isEmpty, isEmtpy, isReadOnly, isReady, recursiveTryLockRegistry, remove, remove, removeDependencyObserver, size, tryLockRegistry, unlockRegistry

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

checkWriteAccess, isWritable

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

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

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

registerShutdownHook, registerShutdownHook, shutdown

Constructor Detail

RegistrySandboxImpl

public RegistrySandboxImpl(MAP entryMap,
                           R originRegistry)
                    throws CouldNotPerformException,
                           InterruptedException

Throws:

CouldNotPerformException

InterruptedException

RegistrySandboxImpl

public RegistrySandboxImpl(MAP entryMap,
                           RegistryCloner<KEY,ENTRY,MAP> cloner,
                           R originRegistry)
                    throws CouldNotPerformException,
                           InterruptedException

Throws:

CouldNotPerformException

InterruptedException

Method Detail

replaceInternalMap

public void replaceInternalMap(Map<KEY,ENTRY> map,
                               boolean finishTransaction)
                        throws CouldNotPerformException

Description copied from class: AbstractRegistry

Replaces the internal registry map by the given one.

Use with care!

Overrides:

replaceInternalMap in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

finishTransaction - is true the registry transaction will be verified.

Throws:

CouldNotPerformException

superRemove

public ENTRY superRemove(ENTRY entry)
                  throws CouldNotPerformException

Overrides:

superRemove in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

Throws:

CouldNotPerformException

update

public ENTRY update(ENTRY entry)
             throws CouldNotPerformException

Description copied from class: AbstractRegistry

Specified by:

update in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

update in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

Parameters:

entry -

Returns:

Throws:

CouldNotPerformException

register

public ENTRY register(ENTRY entry)
               throws CouldNotPerformException

Description copied from class: AbstractRegistry

Method registers the given entry.

Specified by:

register in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

register in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

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.

sync

public void sync(MAP map)
          throws CouldNotPerformException

Specified by:

sync in interface RegistrySandbox<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>>

Throws:

CouldNotPerformException

addObserver

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

Specified by:

addObserver in interface org.openbase.jul.pattern.Observable<Map<KEY,ENTRY extends Identifiable<KEY>>>

Overrides:

addObserver in class org.openbase.jul.pattern.AbstractObservable<Map<KEY,ENTRY extends Identifiable<KEY>>>

finishTransaction

protected void finishTransaction()
                          throws CouldNotPerformException

Overrides:

finishTransaction in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

Throws:

CouldNotPerformException

isSandbox

public boolean isSandbox()

Description copied from class: AbstractRegistry

Specified by:

isSandbox in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

isSandbox in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

Returns:

toString

public String toString()

Description copied from class: AbstractRegistry

Overrides:

toString in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,R extends Registry<KEY,ENTRY>,P extends RegistryPlugin<KEY,ENTRY,R>>

Returns: