public interface ProductDerivation
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.Modifier and Type | Field and Description |
---|---|
static int |
TYPE_FEATURE |
static int |
TYPE_PRODUCT |
Modifier and Type | Method and Description |
---|---|
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. |
List<String> |
getAnchorsInFile(File file)
Return a List
file . |
List<String> |
getAnchorsInResource(String resource)
Return a List
resource . |
String |
getConfigurationPrefix()
Return the configuration prefix for properties of this product.
|
String |
getDefaultResourceLocation()
Return a string identifying the default resource location for this
product derivation, if one exists.
|
Set<String> |
getSupportedQueryHints()
Return set of Query hint keys recognized by this receiver.
|
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.
|
static final int TYPE_PRODUCT
static final int TYPE_FEATURE
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
resourceException
ConfigurationProvider load(File file, String anchor) throws Exception
anchor
- optional named anchor within a multiple-configuration fileException
String getDefaultResourceLocation()
null
.List<String> getAnchorsInFile(File file) throws IOException, Exception
file
.
The returned names are not fully-qualified, so must be used in
conjunction with file
in calls
to load(java.io.File, String)
.
Returns null
or an empty list if no anchors could be found.IOException
Exception
List<String> getAnchorsInResource(String resource) throws Exception
resource
. The returned names are not
fully-qualified, so must be used in conjunction with
resource
in calls to load(java.io.File, String)
.
Returns null
or an empty list if no anchors could be found.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)
Copyright © 2006–2022 Apache Software Foundation. All rights reserved.