info.magnolia.config.source.yaml

Class AbstractFileResourceConfigurationSource<T>

java.lang.Object

info.magnolia.config.source.yaml.AbstractFileResourceConfigurationSource<T>

Type Parameters:

T - type the source will provide

All Implemented Interfaces:

ConfigurationSource

Direct Known Subclasses:

YamlConfigurationSource

public abstract class AbstractFileResourceConfigurationSource<T>
extends Object
implements ConfigurationSource

Configuration source for any text-resource based configuration files.

Constructor Summary

Constructors

Constructor and Description
AbstractFileResourceConfigurationSource(info.magnolia.resourceloader.ResourceOrigin<?> origin, Registry<T> registry, Pattern pathPattern) Deprecated. since 5.5.6 - use AbstractFileResourceConfigurationSource(ResourceOrigin, Registry, Pattern, ModuleRegistry) instead.
AbstractFileResourceConfigurationSource(info.magnolia.resourceloader.ResourceOrigin<?> origin, Registry<T> registry, Pattern pathPattern, info.magnolia.module.ModuleRegistry moduleRegistry)

Method Summary

Modifier and Type	Method and Description
protected DefinitionMetadataBuilder	createMetadata(info.magnolia.resourceloader.Resource resource)
protected Registry<T>	getRegistry()
protected Map<String,FileDefinitionDecorator<T>>	getResolvedDefinitionDecorators() Get currently resolved file decorators mapped to the paths of the files they are resolved from.
protected Class<T>	getRootType()
abstract void	loadAndRegister(info.magnolia.resourceloader.Resource resource)
protected void	registerDefinitionDecoratorResolver(FileDefinitionDecoratorResolver resolver)
protected void	removeDefinitionsMatchingPath(String removedResourcePath)
void	start()
protected void	startDecoration()
ConfigurationSourceType	type()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileResourceConfigurationSource

@Deprecated
public AbstractFileResourceConfigurationSource(info.magnolia.resourceloader.ResourceOrigin<?> origin,
                                                           Registry<T> registry,
                                                           Pattern pathPattern)

Deprecated. since 5.5.6 - use AbstractFileResourceConfigurationSource(ResourceOrigin, Registry, Pattern, ModuleRegistry) instead.

AbstractFileResourceConfigurationSource

public AbstractFileResourceConfigurationSource(info.magnolia.resourceloader.ResourceOrigin<?> origin,
                                               Registry<T> registry,
                                               Pattern pathPattern,
                                               info.magnolia.module.ModuleRegistry moduleRegistry)

Parameters:

pathPattern - a regular expression pattern used to determine whether a file should be considered by the source or not. If the pattern contains a group, it will be used to determine the name of the given object, if not explicitly configured.

Method Detail

type

public ConfigurationSourceType type()

Specified by:

type in interface ConfigurationSource

start

public void start()

Specified by:

start in interface ConfigurationSource

startDecoration

protected void startDecoration()

removeDefinitionsMatchingPath

protected final void removeDefinitionsMatchingPath(String removedResourcePath)

loadAndRegister

public abstract void loadAndRegister(info.magnolia.resourceloader.Resource resource)

getRegistry

protected Registry<T> getRegistry()

getRootType

protected final Class<T> getRootType()

createMetadata

protected DefinitionMetadataBuilder createMetadata(info.magnolia.resourceloader.Resource resource)

registerDefinitionDecoratorResolver

protected final void registerDefinitionDecoratorResolver(FileDefinitionDecoratorResolver resolver)

getResolvedDefinitionDecorators

protected final Map<String,FileDefinitionDecorator<T>> getResolvedDefinitionDecorators()

Get currently resolved file decorators mapped to the paths of the files they are resolved from.