info.magnolia.config.registry

Class AbstractRegistry<T>

java.lang.Object

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

Type Parameters:

T - the type of the contained objects

All Implemented Interfaces:

DefinitionReferenceIdResolver, Registry<T>

public abstract class AbstractRegistry<T>
extends Object
implements Registry<T>

Abstract Registry base class holding a map of all objects of the defined type.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.config.registry.Registry

Registry.InvalidDefinitionException, Registry.NoSuchDefinitionException

Constructor Summary

Constructors

Constructor and Description
AbstractRegistry() Deprecated. since 5.4.6, use #AbstractRegistry(info.magnolia.module.ModuleRegistry.
AbstractRegistry(info.magnolia.module.ModuleRegistry moduleRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDecorator(DefinitionDecorator<T> definitionDecorator)
Collection<T>	getAllDefinitions() Returns all resolvable, valid and enabled definitions.
Collection<DefinitionMetadata>	getAllMetadata()
Collection<DefinitionProvider<T>>	getAllProviders()
protected DefinitionProvider<T>	getDecoratedDefinitionProvider(DefinitionProvider<T> provider)
DefinitionProvider<T>	getProvider(DefinitionMetadata id) Gets a definition provider by its complete id object.
DefinitionProvider<T>	getProvider(String referenceId) Convenience method, where the given String is what the corresponding DefinitionMetadata.getReferenceId() would return.
String	getReferenceId(DefinitionReference definitionReference)
protected RegistryMap<T>	getRegistryMap()
protected DefinitionProvider<T>	onRegister(DefinitionProvider<T> provider) This default implementation wraps the given provider when the definition is a NamedDefinition; in such cases, the definition is proxied and its getName() method is intercepted and redirected to DefinitionReference.getName().
DefinitionQuery<T>	query() Implementations are expected to return a subtype of DefinitionQuery that's able to callback its registry to perform the search.
void	register(DefinitionProvider<T> provider)
void	removeDecorator(DefinitionDecorator<T> definitionDecorator)
void	start() Call start() once sources have been added; addSource() should however call source.startWith(registry) so maybe not ?
Set<DefinitionMetadata>	unregisterAndRegister(Collection<DefinitionMetadata> registeredIds, Collection<DefinitionProvider<T>> providers)

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.config.registry.Registry

newMetadataBuilder, type

Constructor Detail

AbstractRegistry

@Deprecated
public AbstractRegistry()

Deprecated. since 5.4.6, use #AbstractRegistry(info.magnolia.module.ModuleRegistry.

AbstractRegistry

public AbstractRegistry(info.magnolia.module.ModuleRegistry moduleRegistry)

Method Detail

start

public void start()

Description copied from interface: Registry

Call start() once sources have been added; addSource() should however call source.startWith(registry) so maybe not ?

Specified by:

start in interface Registry<T>

getRegistryMap

protected RegistryMap<T> getRegistryMap()

register

public void register(DefinitionProvider<T> provider)

Specified by:

register in interface Registry<T>

unregisterAndRegister

public Set<DefinitionMetadata> unregisterAndRegister(Collection<DefinitionMetadata> registeredIds,
                                            Collection<DefinitionProvider<T>> providers)

Specified by:

unregisterAndRegister in interface Registry<T>

onRegister

protected DefinitionProvider<T> onRegister(DefinitionProvider<T> provider)

This default implementation wraps the given provider when the definition is a NamedDefinition; in such cases, the definition is proxied and its getName() method is intercepted and redirected to DefinitionReference.getName(). Overload or override this if the provider for this registry needs to "post-process" the provider/beans being registered. Don't forget to check DefinitionProvider.isValid() before calling DefinitionProvider.get()

See Also:

DefinitionProviderWrapper

getProvider

public DefinitionProvider<T> getProvider(DefinitionMetadata id)

Description copied from interface: Registry

Gets a definition provider by its complete id object.

Specified by:

getProvider in interface Registry<T>

getProvider

public DefinitionProvider<T> getProvider(String referenceId)

Description copied from interface: Registry

Convenience method, where the given String is what the corresponding DefinitionMetadata.getReferenceId() would return.

Specified by:

getProvider in interface Registry<T>

See Also:

DefinitionMetadata.getReferenceId()

getDecoratedDefinitionProvider

protected final DefinitionProvider<T> getDecoratedDefinitionProvider(DefinitionProvider<T> provider)

getAllProviders

public Collection<DefinitionProvider<T>> getAllProviders()

Specified by:

getAllProviders in interface Registry<T>

getAllMetadata

public Collection<DefinitionMetadata> getAllMetadata()

Specified by:

getAllMetadata in interface Registry<T>

getAllDefinitions

public Collection<T> getAllDefinitions()

Description copied from interface: Registry

Returns all resolvable, valid and enabled definitions.

Specified by:

getAllDefinitions in interface Registry<T>

query

public DefinitionQuery<T> query()

Description copied from interface: Registry

Implementations are expected to return a subtype of DefinitionQuery that's able to callback its registry to perform the search.

Specified by:

query in interface Registry<T>

addDecorator

public void addDecorator(DefinitionDecorator<T> definitionDecorator)

Specified by:

addDecorator in interface Registry<T>

removeDecorator

public void removeDecorator(DefinitionDecorator<T> definitionDecorator)

Specified by:

removeDecorator in interface Registry<T>

getReferenceId

public String getReferenceId(DefinitionReference definitionReference)

Specified by:

getReferenceId in interface DefinitionReferenceIdResolver