info.magnolia.rendering.template.registry

Class TemplateDefinitionRegistry

java.lang.Object

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

info.magnolia.rendering.template.registry.TemplateDefinitionRegistry

All Implemented Interfaces:

DefinitionReferenceIdResolver, Registry<TemplateDefinition>

@Singleton
public class TemplateDefinitionRegistry
extends AbstractRegistry<TemplateDefinition>

The central registry of all TemplateDefinitions.

Nested Class Summary

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

Registry.InvalidDefinitionException, Registry.NoSuchDefinitionException

Constructor Summary

Constructors

Constructor and Description
TemplateDefinitionRegistry() Deprecated. since 5.4.6 - use TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry) instead.
TemplateDefinitionRegistry(ModuleRegistry moduleRegistry) Deprecated. since 5.6.2. Use TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry, info.magnolia.rendering.template.registry.validator.TemplateDefinitionValidator) instead.
TemplateDefinitionRegistry(ModuleRegistry moduleRegistry, TemplateDefinitionValidator templateDefinitionValidator)

Method Summary

Modifier and Type	Method and Description
TemplateDefinition	getTemplateDefinition(String id) Deprecated. since 5.4 use AbstractRegistry.getProvider(String)
Collection<TemplateDefinition>	getTemplateDefinitions() Deprecated. since 5.4 use AbstractRegistry.getAllDefinitions()
DefinitionMetadataBuilder	newMetadataBuilder() Implementations of DefinitionMetadataBuilder determine how referenceId strings for this registry are generated.
protected DefinitionProvider<TemplateDefinition>	onRegister(DefinitionProvider<TemplateDefinition> provider)
void	register(TemplateDefinitionProvider provider) Deprecated. since 5.4
DefinitionType	type()

Methods inherited from class info.magnolia.config.registry.AbstractRegistry

addDecorator, addValidator, getAllDefinitions, getAllMetadata, getAllProviders, getDecoratedDefinitionProvider, getProvider, getProvider, getReferenceId, getRegistryMap, query, register, removeDecorator, start, unregisterAndRegister, validate

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

newDefinitionProviderBuilder

Constructor Detail

TemplateDefinitionRegistry

@Inject
public TemplateDefinitionRegistry(ModuleRegistry moduleRegistry,
                                          TemplateDefinitionValidator templateDefinitionValidator)

TemplateDefinitionRegistry

@Deprecated
public TemplateDefinitionRegistry(ModuleRegistry moduleRegistry)

Deprecated. since 5.6.2. Use TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry, info.magnolia.rendering.template.registry.validator.TemplateDefinitionValidator) instead.

TemplateDefinitionRegistry

@Deprecated
public TemplateDefinitionRegistry()

Deprecated. since 5.4.6 - use TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry) instead.

Method Detail

type

public DefinitionType type()

newMetadataBuilder

public DefinitionMetadataBuilder newMetadataBuilder()

Description copied from interface: Registry

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.

register

@Deprecated
public void register(TemplateDefinitionProvider provider)

Deprecated. since 5.4

This method is kept for compatibility reasons. It adapts the given provider to the new DefinitionProvider introduced in 5.4.

getTemplateDefinition

@Deprecated
public TemplateDefinition getTemplateDefinition(String id)
                                                     throws RegistrationException

Deprecated. since 5.4 use AbstractRegistry.getProvider(String)

Throws:

RegistrationException

onRegister

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

Overrides:

onRegister in class AbstractRegistry<TemplateDefinition>

getTemplateDefinitions

@Deprecated
public Collection<TemplateDefinition> getTemplateDefinitions()

Deprecated. since 5.4 use AbstractRegistry.getAllDefinitions()

Returns all TemplateDefinitions - in case of errors it'll just deliver the ones that are properly registered and logs error's for the others.