info.magnolia.config.source.yaml

Class YamlConfigurationSourceBuilder

java.lang.Object

info.magnolia.config.source.AbstractConfigurationSourceBuilder

info.magnolia.config.source.yaml.YamlConfigurationSourceBuilder

All Implemented Interfaces:

ConfigurationSourceBuilder

public class YamlConfigurationSourceBuilder
extends AbstractConfigurationSourceBuilder

Builder for YamlConfigurationSource instances.

Constructor Summary

Constructors

Constructor and Description
YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader) Deprecated. since 5.5 - use YamlConfigurationSourceBuilder(ResourceOrigin, Map2BeanTransformer, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.
YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin, info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, info.magnolia.init.MagnoliaConfigurationProperties magnoliaConfigurationProperties) Deprecated. since 5.5.6 - use YamlConfigurationSourceBuilder(ResourceOrigin, Map2BeanTransformer, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.
YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin, info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, info.magnolia.init.MagnoliaConfigurationProperties magnoliaConfigurationProperties, info.magnolia.module.ModuleRegistry moduleRegistry)

Method Summary

Modifier and Type	Method and Description
void	bindTo(Registry<?> registry)
void	bindWithDefaults(Registry registry)
protected String	moduleConventionsFormatFor(Registry registry)
protected Pattern	validatePathPattern(String regex)
YamlConfigurationSourceBuilder	withCustomConstruct(String tag, org.yaml.snakeyaml.constructor.Construct construct)
YamlConfigurationSourceBuilder	withCustomMultiConstruct(String tagPrefix, org.yaml.snakeyaml.constructor.Construct construct)
YamlConfigurationSourceBuilder	withPattern(String pathPattern)

Methods inherited from class info.magnolia.config.source.AbstractConfigurationSourceBuilder

pluralTypeNameOf, typeNameOf

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlConfigurationSourceBuilder

@Deprecated
public YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin,
                                                  Map2BeanTransformer map2BeanTransformer,
                                                  YamlReader yamlReader)

Deprecated. since 5.5 - use YamlConfigurationSourceBuilder(ResourceOrigin, Map2BeanTransformer, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.

YamlConfigurationSourceBuilder

@Deprecated
public YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin,
                                                  info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer,
                                                  YamlReader yamlReader,
                                                  info.magnolia.init.MagnoliaConfigurationProperties magnoliaConfigurationProperties)

Deprecated. since 5.5.6 - use YamlConfigurationSourceBuilder(ResourceOrigin, Map2BeanTransformer, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry) instead.

YamlConfigurationSourceBuilder

public YamlConfigurationSourceBuilder(info.magnolia.resourceloader.ResourceOrigin origin,
                                      info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer,
                                      YamlReader yamlReader,
                                      info.magnolia.init.MagnoliaConfigurationProperties magnoliaConfigurationProperties,
                                      info.magnolia.module.ModuleRegistry moduleRegistry)

Method Detail

withPattern

public YamlConfigurationSourceBuilder withPattern(String pathPattern)

withCustomMultiConstruct

public YamlConfigurationSourceBuilder withCustomMultiConstruct(String tagPrefix,
                                                               org.yaml.snakeyaml.constructor.Construct construct)

withCustomConstruct

public YamlConfigurationSourceBuilder withCustomConstruct(String tag,
                                                          org.yaml.snakeyaml.constructor.Construct construct)

bindTo

public void bindTo(Registry<?> registry)

bindWithDefaults

public void bindWithDefaults(Registry registry)

validatePathPattern

protected Pattern validatePathPattern(String regex)

moduleConventionsFormatFor

protected String moduleConventionsFormatFor(Registry registry)