org.trimou.engine.config

Class AbstractConfigurationAware

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

All Implemented Interfaces:

ConfigurationAware

Direct Known Subclasses:

AbstractHelper, AbstractMustacheListener, AbstractResolver, AbstractTemplateLocator, BracketDotKeySplitter, DefaultComputingCacheFactory, DotKeySplitter, FixedLocaleSupport, NoOpMissingValueHandler, SequenceIdentifierGenerator, ThrowingExceptionMissingValueHandler

public abstract class AbstractConfigurationAware
extends Object
implements ConfigurationAware

Abstract configuration aware component.

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationAware()

Method Summary

Modifier and Type	Method and Description
Set<ConfigurationKey>	getConfigurationKeys()
protected void	checkNotInitialized(boolean isInitializedExpression)
protected void	init() Can be overridden so that there's no need to call super.init(Configuration).
void	init(Configuration configuration) Initialize the component.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected Configuration configuration

Constructor Detail

AbstractConfigurationAware

public AbstractConfigurationAware()

Method Detail

init

public void init(Configuration configuration)

Description copied from interface: ConfigurationAware

Initialize the component. Keep in mind that the configuration itself might not be fully initialized yet. However it should be safe to inspect non-configurable components (e.g. properties and global data) and obtain references to other ConfigurationAware components e.g. ( LocaleSupport). This method must not be called directly by the application.

Specified by:

init in interface ConfigurationAware

init

protected void init()

Can be overridden so that there's no need to call super.init(Configuration).

getConfigurationKeys

public Set<ConfigurationKey> getConfigurationKeys()

Specified by:

getConfigurationKeys in interface ConfigurationAware

Returns:

the set of configuration keys to discover

checkNotInitialized

protected void checkNotInitialized(boolean isInitializedExpression)

Throws:

IllegalStateException - If the isInitializedExpression evaluates to true