info.magnolia.config.registry

Class RegistryMap<T>

java.lang.Object

info.magnolia.config.registry.RegistryMap<T>

Type Parameters:

T - the type of the contained objects

public class RegistryMap<T>
extends Object

Thread safe map intended to be used for registries. Provides an atomic operation removeAndPutAll that is used to remove a set of previously added values before adding a collection of new ones. Read operations are blocked until it completes guaranteeing proper visibility.

It is common for entities in registries to also hold their identifier. The method keyFormValue can be overridden to get the identifier from the value. This removes the need to package a set of entities that should be added in a Map before calling removeAndPutAll(java.util.Collection, java.util.Collection). This is a port and simplified version of RegistryMap, which was written prior to the introduction of the Registry interface. It should not be used directly.

Constructor Summary

Constructors

Constructor and Description
RegistryMap()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	asStringKey(DefinitionProvider<T> provider)
DefinitionProvider<T>	get(DefinitionMetadata key)
DefinitionProvider<T>	getByStringKey(String stringKey)
DefinitionProvider<T>	getRequired(DefinitionMetadata key)
DefinitionProvider<T>	getRequiredByStringKey(String stringKey)
protected DefinitionMetadata	keyFromValue(DefinitionProvider<T> provider)
Collection<DefinitionMetadata>	keySet()
DefinitionMetadata	put(DefinitionProvider<T> value)
void	remove(DefinitionMetadata key)
Set<DefinitionMetadata>	removeAndPutAll(Collection<DefinitionMetadata> toRemove, Collection<DefinitionProvider<T>> toPut)
Collection<DefinitionProvider<T>>	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryMap

public RegistryMap()

Method Detail

get

public DefinitionProvider<T> get(DefinitionMetadata key)

getByStringKey

public DefinitionProvider<T> getByStringKey(String stringKey)

getRequired

public DefinitionProvider<T> getRequired(DefinitionMetadata key)
                                  throws RegistrationException

Throws:

RegistrationException

getRequiredByStringKey

public DefinitionProvider<T> getRequiredByStringKey(String stringKey)
                                             throws RegistrationException

Throws:

RegistrationException

put

public DefinitionMetadata put(DefinitionProvider<T> value)

remove

public void remove(DefinitionMetadata key)

removeAndPutAll

public Set<DefinitionMetadata> removeAndPutAll(Collection<DefinitionMetadata> toRemove,
                                      Collection<DefinitionProvider<T>> toPut)

keySet

public Collection<DefinitionMetadata> keySet()

values

public Collection<DefinitionProvider<T>> values()

keyFromValue

protected DefinitionMetadata keyFromValue(DefinitionProvider<T> provider)

asStringKey

protected String asStringKey(DefinitionProvider<T> provider)