Registry (Magnolia Main Project (Parent) 6.2 API)

Type Parameters:

T - element type of this registry

All Superinterfaces:

DefinitionReferenceIdResolver

All Known Implementing Classes:

AbstractRegistry, RendererRegistry, TemplateDefinitionRegistry, VirtualUriRegistry
```
@Multibinding
public interface Registry<T>
extends DefinitionReferenceIdResolver
```
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

All Methods Instance Methods Abstract Methods Default Methods Deprecated 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()`
`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.
`default DefinitionProviderBuilder<T>`	`newDefinitionProviderBuilder()`
`DefinitionMetadataBuilder`	`newMetadataBuilder()` Implementations of `DefinitionMetadataBuilder` determine how referenceId strings for this registry are generated.
`DefinitionQuery<T>`	`query()` Deprecated. as of 5.5 - directly instantiate an implementation of `DefinitionQuery`
`void`	`register(DefinitionProvider<T> definitionProvider)`
`void`	`removeDecorator(DefinitionDecorator<T> definitionDecorator)`
`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)`

Methods inherited from interface info.magnolia.config.registry.DefinitionReferenceIdResolver
getReferenceId

- Method Detail
  - type
```
DefinitionType type()
```
  - newMetadataBuilder
```
DefinitionMetadataBuilder newMetadataBuilder()
```
    Implementations of DefinitionMetadataBuilder determine how referenceId strings for this registry are generated. FIXME since 5.4.6 historically this method exists so that specific Registry implementation can provide its own strategy of converting a DefinitionMetadata to a string. With introduction of DefinitionReferenceIdResolver interface metadata can lose DefinitionMetadata.getReferenceId() method and will not need a special per-registry metadata builder.
  - newDefinitionProviderBuilder
```
default DefinitionProviderBuilder<T> newDefinitionProviderBuilder()
```
  - 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)
```
  - addDecorator
```
void addDecorator(DefinitionDecorator<T> definitionDecorator)
```
  - removeDecorator
```
void removeDecorator(DefinitionDecorator<T> definitionDecorator)
```
  - 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
```
@Deprecated
DefinitionQuery<T> query()
```
    Deprecated. as of 5.5 - directly instantiate an implementation of DefinitionQuery
    
    Implementations are expected to return a subtype of DefinitionQuery that's able to callback its registry to perform the search.

Interface Registry<T>

Nested Class Summary

Method Summary

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

Method Detail

type

newMetadataBuilder

newDefinitionProviderBuilder

start

register

addDecorator

removeDecorator

unregisterAndRegister

getProvider

getProvider

getAllProviders

getAllDefinitions

getAllMetadata

query