info.magnolia.config.source.yaml

Class YamlDefinitionProvider<T>

java.lang.Object

info.magnolia.config.registry.AbstractDefinitionProviderWrapper<T>

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

Type Parameters:

T - definition type

All Implemented Interfaces:

DefinitionProvider<T>

public class YamlDefinitionProvider<T>
extends AbstractDefinitionProviderWrapper<T>

Dynamic DefinitionProvider implementation which wraps a YAML resource and tracks its dependencies. The underlying definition would be re-resolved once any of the dependency files are modified.

Nested Class Summary

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

DefinitionProvider.Problem

Constructor Summary

Constructors

Constructor and Description
YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource, info.magnolia.resourceloader.Resource yamlResource, info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader) Deprecated. since 5.5.6 - use YamlDefinitionProvider(YamlConfigurationSource, Resource, Map2BeanTransformer, YamlReader, ModuleRegistry) instead.
YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource, info.magnolia.resourceloader.Resource yamlResource, info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, info.magnolia.module.ModuleRegistry moduleRegistry) Deprecated. since 6.1 - use YamlDefinitionProvider(YamlConfigurationSource, Resource, Map2BeanTransformer, YamlReader, ModuleRegistry, Map, Map) instead.
YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource, info.magnolia.resourceloader.Resource yamlResource, info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, info.magnolia.module.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
protected DefinitionProvider<T>	getDelegate()
long	getLastModified() Returns the timestamp of the last change of the underlying definition change.

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

get, getDecorators, getErrorMessages, getMetadata, getProblems, getRaw, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlDefinitionProvider

public YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource,
                              info.magnolia.resourceloader.Resource yamlResource,
                              info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer,
                              YamlReader yamlReader,
                              info.magnolia.module.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)

YamlDefinitionProvider

@Deprecated
public YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource,
                                          info.magnolia.resourceloader.Resource yamlResource,
                                          info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer,
                                          YamlReader yamlReader,
                                          info.magnolia.module.ModuleRegistry moduleRegistry)

Deprecated. since 6.1 - use YamlDefinitionProvider(YamlConfigurationSource, Resource, Map2BeanTransformer, YamlReader, ModuleRegistry, Map, Map) instead.

YamlDefinitionProvider

@Deprecated
public YamlDefinitionProvider(YamlConfigurationSource<T> relatedSource,
                                          info.magnolia.resourceloader.Resource yamlResource,
                                          info.magnolia.map2bean.Map2BeanTransformer map2BeanTransformer,
                                          YamlReader yamlReader)

Deprecated. since 5.5.6 - use YamlDefinitionProvider(YamlConfigurationSource, Resource, Map2BeanTransformer, YamlReader, ModuleRegistry) instead.

Method Detail

getLastModified

public long getLastModified()

Description copied from interface: DefinitionProvider

Returns the timestamp of the last change of the underlying definition change. If a DefinitionProvider merely wraps a definition instance - such timestamp would never change and be always equal to the provider's creation date. However, if a provider generates the definition on the fly from some resource - the last modified date might change and that might be a clear signal for an update of the structures that decorate/cache definitions.

Specified by:

getLastModified in interface DefinitionProvider<T>

Overrides:

getLastModified in class AbstractDefinitionProviderWrapper<T>

See Also:

CachingDefinitionDecorator

getDelegate

protected DefinitionProvider<T> getDelegate()

Specified by:

getDelegate in class AbstractDefinitionProviderWrapper<T>