info.magnolia.config.registry

Interface Registry<T>

Type Parameters:

T - element type of this registry

All Known Implementing Classes:

AbstractRegistry, RendererRegistry, TemplateDefinitionRegistry

@Multibinding
public interface Registry<T>

An instance of a registry is responsible for one particular DefinitionType; these definition can come from various sources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Registry.InvalidDefinitionException Thrown by a registry when the underlying bean is not successfully resolved, not valid, or not enabled.
static class	Registry.NoSuchDefinitionException Thrown by a registry when it doesn't hold an entity that is asked for.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<T>	getAllDefinitions() Returns all resolvable, valid and enabled definitions.
Collection<DefinitionMetadata>	getAllMetadata()
Collection<DefinitionProvider<T>>	getAllProviders()
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.
DefinitionMetadataBuilder	newMetadataBuilder() Implementations of DefinitionMetadataBuilder determine how referenceId strings for this registry are generated.
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> definitionProvider)
void	start() Call start() once sources have been added; addSource() should however call source.startWith(registry) so maybe not ?
DefinitionType	type()
Set<DefinitionMetadata>	unregisterAndRegister(Collection<DefinitionMetadata> toRemove, Collection<DefinitionProvider<T>> toAdd)

Method Detail

type

DefinitionType type()

newMetadataBuilder

DefinitionMetadataBuilder newMetadataBuilder()

Implementations of DefinitionMetadataBuilder determine how referenceId strings for this registry are generated.

start

void start()

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

register

void register(DefinitionProvider<T> definitionProvider)

unregisterAndRegister

Set<DefinitionMetadata> unregisterAndRegister(Collection<DefinitionMetadata> toRemove,
                                            Collection<DefinitionProvider<T>> toAdd)

getProvider

DefinitionProvider<T> getProvider(DefinitionMetadata id)

Gets a definition provider by its complete id object.

getProvider

DefinitionProvider<T> getProvider(String referenceId)
                                  throws Registry.NoSuchDefinitionException

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

Throws:

Registry.NoSuchDefinitionException - (which is a RuntimeException) if the given reference is not known.

See Also:

DefinitionMetadata.getReferenceId()

getAllProviders

Collection<DefinitionProvider<T>> getAllProviders()

getAllDefinitions

Collection<T> getAllDefinitions()

Returns all resolvable, valid and enabled definitions.

getAllMetadata

Collection<DefinitionMetadata> getAllMetadata()

query

DefinitionQuery<T> query()

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