|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProductDerivation
Hooks for deriving products with additional functionality.
Parses configuration information from global, default or explictly-specified
resources. All implementations of this interface will have a chance to mutate
a Configuration
both before and after the user-specified
configuration data is loaded. The order in which the product derivations are
evaluated is determined by the specificity of the derivation type.
Field Summary | |
---|---|
static int |
TYPE_FEATURE
|
static int |
TYPE_PRODUCT
|
Method Summary | |
---|---|
boolean |
afterSpecificationSet(Configuration conf)
Called after the specification has been set. |
void |
beforeConfigurationClose(Configuration conf)
Called before the given Configuration is closed. |
boolean |
beforeConfigurationConstruct(ConfigurationProvider cp)
Provides the instance with a callback to mutate the initial properties of the ConfigurationProvider . |
boolean |
beforeConfigurationLoad(Configuration conf)
Provides the instance with the opportunity to mutate conf before the user configuration is applied. |
String |
getConfigurationPrefix()
Return the configuration prefix for properties of this product. |
int |
getType()
Return the type of derivation. |
ConfigurationProvider |
load(File file,
String anchor)
Load given file, or return null if it is not a file this receiver understands. |
ConfigurationProvider |
load(String resource,
String anchor,
ClassLoader loader)
Load the given given resource into the returned ConfigurationProvider, or return null if it is not a resource this receiver understands. |
ConfigurationProvider |
loadDefaults(ClassLoader loader)
Load defaults into the returned ConfigurationProvider, or return null if no defaults are found. |
ConfigurationProvider |
loadGlobals(ClassLoader loader)
Load globals into the returned ConfigurationProvider, or return null if no globals are found. |
void |
validate()
Ensure that this derivation is valid. |
Field Detail |
---|
static final int TYPE_PRODUCT
static final int TYPE_FEATURE
Method Detail |
---|
int getType()
String getConfigurationPrefix()
void validate() throws Exception
Exception
ConfigurationProvider loadGlobals(ClassLoader loader) throws Exception
Exception
ConfigurationProvider loadDefaults(ClassLoader loader) throws Exception
Exception
ConfigurationProvider load(String resource, String anchor, ClassLoader loader) throws Exception
anchor
- optional named anchor within a multiple-configuration
resource
Exception
ConfigurationProvider load(File file, String anchor) throws Exception
anchor
- optional named anchor within a multiple-configuration file
Exception
boolean beforeConfigurationConstruct(ConfigurationProvider cp)
ConfigurationProvider
. This is primarily to alter or
add properties that determine what type of configuration is constructed,
and therefore is typically used at runtime only.
boolean beforeConfigurationLoad(Configuration conf)
conf
before the user configuration is applied.
boolean afterSpecificationSet(Configuration conf)
void beforeConfigurationClose(Configuration conf)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |