info.magnolia.config.registry

Interface DefinitionProvider<T>

Type Parameters:

T - the provided type

All Known Implementing Classes:

AbstractDefinitionProviderWrapper, DefinitionProviderWrapper, DefinitionProviderWrapperWithProxyFallback, MapBasedDefinitionProviderWrapper, YamlDefinitionProvider

public interface DefinitionProvider<T>

This is NOT called Provider to avoid confusion with javax.inject.Provider; however, keep in mind that some objects provided by these and registries are not necessarily "just" definition, they might be "live" objects (Renderer is an example). Naming this ConfiguredObjectProvider might have been more correct, but also a bit long.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DefinitionProvider.Problem Allows to record and memoize the details about an issue which might have occurred during the population of a definition provider.

Method Summary

Modifier and Type	Method and Description
T	get() Returns the underlying bean if and only if it is successfully resolved, is valid, and is enabled.
List<DefinitionDecorator<T>>	getDecorators()
default List<String>	getErrorMessages() Deprecated. since 5.5 - use getProblems() instead.
long	getLastModified() Returns the timestamp of the last change of the underlying definition change.
DefinitionMetadata	getMetadata()
default Collection<DefinitionProvider.Problem>	getProblems()
DefinitionRawView	getRaw() Returns a DefinitionRawView representation the underlying bean; it might be invalid, partially resolved and/or disabled.
boolean	isValid()

Method Detail

getDecorators

List<DefinitionDecorator<T>> getDecorators()

getMetadata

DefinitionMetadata getMetadata()

get

T get()
throws Registry.InvalidDefinitionException

Returns the underlying bean if and only if it is successfully resolved, is valid, and is enabled.

Throws:

Registry.InvalidDefinitionException - (which is a RuntimeException) if the underlying bean is not successfully resolved, not valid, or not enabled.

getRaw

DefinitionRawView getRaw()

Returns a DefinitionRawView representation the underlying bean; it might be invalid, partially resolved and/or disabled.

isValid

boolean isValid()

getLastModified

long getLastModified()

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.

See Also:

CachingDefinitionDecorator

getErrorMessages

@Deprecated
default List<String> getErrorMessages()

Deprecated. since 5.5 - use getProblems() instead.

getProblems

default Collection<DefinitionProvider.Problem> getProblems()