Package net.obvj.confectory
Interface ConfigurationMetadataRetriever<T>
-
- Type Parameters:
T- the target configuration data type
- All Known Implementing Classes:
Configuration,ConfigurationBuilder
public interface ConfigurationMetadataRetriever<T>A base interface for objects that retrieve configuration metadata, such asSource,Mapper, and other attributes.- Since:
- 0.1.0
- Author:
- oswaldo.bapvic.jr (Oswaldo Junior)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Mapper<T>getMapper()Returns theMapperobject associated with thisConfiguration.StringgetNamespace()Returns the namespace defined for thisConfigurationobject.intgetPrecedence()Returns the precedence value defined for thisConfigurationobject.Source<T>getSource()Returns theSourceobject associated with thisConfiguration.booleanisLazy()Returns a flag indicating whether thisConfigurationis lazy, i.e., not loaded until needed.booleanisOptional()Returns a flag indicating whether thisConfigurationis optional.
-
-
-
Method Detail
-
getNamespace
String getNamespace()
Returns the namespace defined for thisConfigurationobject.- Returns:
- the namespace defined for this
Configuration
-
getPrecedence
int getPrecedence()
Returns the precedence value defined for thisConfigurationobject.In a common container, objects with higher-precedence may be selected first in case of key collision.
- Returns:
- an integer number representing the order of importance given to this
Configuration
-
getSource
Source<T> getSource()
Returns theSourceobject associated with thisConfiguration.- Returns:
- a
Sourceinstance
-
getMapper
Mapper<T> getMapper()
Returns theMapperobject associated with thisConfiguration.- Returns:
- a
Mapperinstance
-
isOptional
boolean isOptional()
Returns a flag indicating whether thisConfigurationis optional.An optional
Configurationobject may behave quietly in the event of a failure to load the data.- Returns:
trueif thisConfigurationsetup is optional;false, otherwise
-
isLazy
boolean isLazy()
Returns a flag indicating whether thisConfigurationis lazy, i.e., not loaded until needed.- Returns:
trueif thisConfigurationis lazy;false, otherwise- Since:
- 0.4.0
-
-