info.magnolia.config.source.yaml

Class YamlConfigurationSource<T>

java.lang.Object

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

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

Type Parameters:

T - type the source will provide

All Implemented Interfaces:

ConfigurationSource

public class YamlConfigurationSource<T>
extends AbstractFileResourceConfigurationSource<T>

Configuration source for yaml configuration files.

Constructor Summary

Constructors

Constructor and Description
YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader) Deprecated. since 5.5 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.
YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties) Deprecated. since 5.5.6 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.
YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties, ModuleRegistry moduleRegistry) Deprecated. since 6.1 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry, Map, Map) instead.
YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties, ModuleRegistry moduleRegistry, Map<String,Function<Consumer<DefinitionProvider.Problem>,org.yaml.snakeyaml.constructor.Construct>> customConstructs, Map<String,Function<Consumer<DefinitionProvider.Problem>,org.yaml.snakeyaml.constructor.Construct>> customMultiConstructs)

Method Summary

Modifier and Type	Method and Description
void	loadAndRegister(Resource resource)
protected void	startDecoration()

Methods inherited from class info.magnolia.config.source.yaml.AbstractFileResourceConfigurationSource

createMetadata, getRegistry, getResolvedDefinitionDecorators, getRootType, registerDefinitionDecoratorResolver, removeDefinitionsMatchingPath, start, type

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlConfigurationSource

public YamlConfigurationSource(ResourceOrigin origin,
                               Map2BeanTransformer map2BeanTransformer,
                               Registry<T> registry,
                               Pattern pathPattern,
                               YamlReader yamlReader,
                               MagnoliaConfigurationProperties magnoliaConfigurationProperties,
                               ModuleRegistry moduleRegistry,
                               Map<String,Function<Consumer<DefinitionProvider.Problem>,org.yaml.snakeyaml.constructor.Construct>> customConstructs,
                               Map<String,Function<Consumer<DefinitionProvider.Problem>,org.yaml.snakeyaml.constructor.Construct>> customMultiConstructs)

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.

YamlConfigurationSource

@Deprecated
public YamlConfigurationSource(ResourceOrigin origin,
                                           Map2BeanTransformer map2BeanTransformer,
                                           Registry<T> registry,
                                           Pattern pathPattern,
                                           YamlReader yamlReader)

Deprecated. since 5.5 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.

YamlConfigurationSource

@Deprecated
public YamlConfigurationSource(ResourceOrigin origin,
                                           Map2BeanTransformer map2BeanTransformer,
                                           Registry<T> registry,
                                           Pattern pathPattern,
                                           YamlReader yamlReader,
                                           MagnoliaConfigurationProperties magnoliaConfigurationProperties)

Deprecated. since 5.5.6 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.

YamlConfigurationSource

@Deprecated
public YamlConfigurationSource(ResourceOrigin origin,
                                           Map2BeanTransformer map2BeanTransformer,
                                           Registry<T> registry,
                                           Pattern pathPattern,
                                           YamlReader yamlReader,
                                           MagnoliaConfigurationProperties magnoliaConfigurationProperties,
                                           ModuleRegistry moduleRegistry)

Deprecated. since 6.1 - use YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry, Map, Map) instead.

Method Detail

startDecoration

protected void startDecoration()

Overrides:

startDecoration in class AbstractFileResourceConfigurationSource<T>

loadAndRegister

public void loadAndRegister(Resource resource)

Specified by:

loadAndRegister in class AbstractFileResourceConfigurationSource<T>