public interface ConfigurationFinder
A ConfigurationFinder is an object that looks for a Configuration given a configuration name. It is also capable of listing components for which configurations exist at some level in the configuration namespace.
Modifier and Type | Interface and Description |
---|---|
static interface |
ConfigurationFinder.ConfigurationList
Inner interface that records a collection of configurations
discovered by calling listConfigurations().
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_SUFFIX |
static int |
CLASS_SUFFIX_LEN |
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
GLOBAL_PROPERTIES |
static java.lang.String |
JAVA_SUFFIX |
static int |
JAVA_SUFFIX_LEN |
static java.lang.String |
PROPERTIES_SUFFIX |
static int |
PROPERTIES_SUFFIX_LEN |
Modifier and Type | Method and Description |
---|---|
Configuration |
findConfiguration(java.lang.String pName,
boolean pSearchUp,
java.lang.String pBaseName,
ApplicationLogging pLog)
Finds and returns the configuration for the specified name.
|
void |
listConfigurations(java.lang.String pName,
ConfigurationFinder.ConfigurationList pCollection)
Finds and returns a list of configurable objects that could
be found by this ConfigurationFinder within some naming context
in the configuration namespace.
|
static final java.lang.String CLASS_VERSION
static final java.lang.String GLOBAL_PROPERTIES
static final java.lang.String PROPERTIES_SUFFIX
static final int PROPERTIES_SUFFIX_LEN
static final java.lang.String CLASS_SUFFIX
static final int CLASS_SUFFIX_LEN
static final java.lang.String JAVA_SUFFIX
static final int JAVA_SUFFIX_LEN
Configuration findConfiguration(java.lang.String pName, boolean pSearchUp, java.lang.String pBaseName, ApplicationLogging pLog)
pName
- the name for which a configuration is to be foundpSearchUp
- the flag indicating whether a search should
be performed up the tree if the name is not found in its literal
form.pBaseName
- if search up is on, then this is the portion of
the name that will remain constant. For example, if the name is
"/a/b/c/d/e/test1" and the base name is "/e/test1", then this
will search for "/a/b/c/d/e/test1", "/a/b/c/e/test1",
"/a/b/e/test1", "/a/e/test1", and "/e/test1".pLog
- the ApplicationLogging to which the configuration
finder should print informative messages as it tries to find the
configuration. If null, then no informative messages should be
printed.void listConfigurations(java.lang.String pName, ConfigurationFinder.ConfigurationList pCollection)
pName
- the name of the context in which to lookpCollection
- a collection into which the names of discovered
collections can be found.