info.magnolia.config.registry

Class AbstractDefinitionProviderWrapper<T>

java.lang.Object

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

Type Parameters:

T - type of provided elements

All Implemented Interfaces:

DefinitionProvider<T>

Direct Known Subclasses:

DefinitionProviderWrapper, YamlDefinitionProvider

public abstract class AbstractDefinitionProviderWrapper<T>
extends Object
implements DefinitionProvider<T>

Abstract implementation of DefinitionProvider wrappers. Allows for any implementation of delegation via abstract getDelegate() method.

Nested Class Summary

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

DefinitionProvider.Problem

Constructor Summary

Constructors

Constructor and Description
AbstractDefinitionProviderWrapper()

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()
protected abstract DefinitionProvider<T>	getDelegate()
List<String>	getErrorMessages()
long	getLastModified() Returns the timestamp of the last change of the underlying definition change.
DefinitionMetadata	getMetadata()
Collection<DefinitionProvider.Problem>	getProblems()
DefinitionRawView	getRaw() Returns a DefinitionRawView representation the underlying bean; it might be invalid, partially resolved and/or disabled.
boolean	isValid()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDefinitionProviderWrapper

public AbstractDefinitionProviderWrapper()

Method Detail

getDecorators

public List<DefinitionDecorator<T>> getDecorators()

Specified by:

getDecorators in interface DefinitionProvider<T>

getMetadata

public DefinitionMetadata getMetadata()

Specified by:

getMetadata in interface DefinitionProvider<T>

get

public T get()
      throws Registry.InvalidDefinitionException

Description copied from interface: DefinitionProvider

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

Specified by:

get in interface DefinitionProvider<T>

Throws:

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

getRaw

public DefinitionRawView getRaw()

Description copied from interface: DefinitionProvider

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

Specified by:

getRaw in interface DefinitionProvider<T>

isValid

public boolean isValid()

Specified by:

isValid in interface DefinitionProvider<T>

getErrorMessages

public List<String> getErrorMessages()

Specified by:

getErrorMessages in interface DefinitionProvider<T>

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>

See Also:

CachingDefinitionDecorator

getProblems

public Collection<DefinitionProvider.Problem> getProblems()

Specified by:

getProblems in interface DefinitionProvider<T>

getDelegate

protected abstract DefinitionProvider<T> getDelegate()