public class FactoryConfiguration extends CompoundConfiguration<ToolboxConfiguration>
This class serves to define configuration info for a ToolboxFactory
.
It contains the ToolboxConfiguration
s for the factory as well
as any Data
which is to be made available in the application scope
by the factory and any Property
s which you intend to be available
to all tools managed by the factory, regardless of
toolbox or scope.
Most users will not find themselves directly using the API of this class, as its subclasses generally provide much simpler means of inputting the actual configuration info whether from XML, Java or a Properties files.
When combining any Configuration
s via the various
addConfiguration(org.apache.velocity.tools.config.FactoryConfiguration)
methods in each class, it is
essential to remember that subsequent configurations
always override previous ones. This is a "last entry wins" approach
to configuration!
For debugging, this class tracks its "sources", keeping a chronological list
of all sources for configuration data. When you add configuration info
to this class via addConfiguration(org.apache.velocity.tools.config.FactoryConfiguration)
, the source lists from those
FactoryConfiguration
s is appended to this instance's list. The
initial item in this list will typically be the name of the FactoryConfiguration
class (or subclass) along with a caller-provided string identifying where
this instance was created. This aids greatly in debugging combined, complex
configurations. You may add further sources at any time via
addSource(java.lang.String)
.
The toString()
method of this class provides a complete and
well-formatted listing of the configuration info contained within this
instance and is also very useful for debugging.
Modifier | Constructor and Description |
---|---|
|
FactoryConfiguration() |
protected |
FactoryConfiguration(Class clazz,
String source)
Allows subclasses to construct an instance that uses their classname.
|
|
FactoryConfiguration(String source)
Creates a new instance with the specified source name
combined with this class's name as the initial source.
|
Modifier and Type | Method and Description |
---|---|
void |
addConfiguration(FactoryConfiguration config) |
void |
addData(Data newDatum) |
void |
addSource(String source) |
void |
addToolbox(ToolboxConfiguration toolbox) |
ToolboxFactory |
createFactory() |
boolean |
equals(Object o)
This will consider the object equal if it is a FactoryConfiguration
and whose
toString(boolean) method, when passed false ,
returns a String equal to that returned by a call to toString(false) on this
instance. |
SortedSet<Data> |
getData() |
Data |
getData(Data findme)
Search for Data by value
|
Data |
getData(String key)
Search for Data by key
|
String |
getSource()
Returns the original source of this particular instance.
|
List<String> |
getSources()
Returns the list of sources for this configuration info in
order starting from the source name given to this instance
(if any) and going to the most recently added source.
|
ToolboxConfiguration |
getToolbox(String scope) |
Collection<ToolboxConfiguration> |
getToolboxes() |
boolean |
hasData() |
int |
hashCode() |
boolean |
removeData(Data datum) |
void |
removeToolbox(ToolboxConfiguration toolbox) |
void |
setData(Collection<Data> data) |
void |
setSource(String source)
Sets the name of the original source of this particular instance.
|
void |
setToolboxes(Collection<ToolboxConfiguration> toolboxes) |
String |
toString() |
String |
toString(boolean includeSources) |
void |
validate() |
addChild, addConfiguration, appendChildren, getChild, getChildren, hasChildren, removeChild, setChildren
addConfiguration, addProperty, appendProperties, compareTo, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
public FactoryConfiguration()
public FactoryConfiguration(String source)
source
- configuration source namepublic String getSource()
public void setSource(String source)
source
- configuration source namepublic List<String> getSources()
public void addSource(String source)
source
- source to addpublic void addData(Data newDatum)
newDatum
- data to addpublic boolean removeData(Data datum)
datum
- data to removetrue
if removedpublic Data getData(String key)
key
- key of data to getpublic Data getData(Data findme)
findme
- value to findpublic boolean hasData()
public void setData(Collection<Data> data)
public void addToolbox(ToolboxConfiguration toolbox)
public void removeToolbox(ToolboxConfiguration toolbox)
public ToolboxConfiguration getToolbox(String scope)
public Collection<ToolboxConfiguration> getToolboxes()
public void setToolboxes(Collection<ToolboxConfiguration> toolboxes)
public void addConfiguration(FactoryConfiguration config)
public void validate()
validate
in class CompoundConfiguration<ToolboxConfiguration>
public boolean equals(Object o)
toString(boolean)
method, when passed false
,
returns a String equal to that returned by a call to toString(false) on this
instance. toString(boolean)
is used since that returns a String
encompassing all relevant info about the configuration except for the
source information. In other words, two FactoryConfigurations are considered
equal if they have the same data, properties and toolboxes in String form.equals
in class CompoundConfiguration<ToolboxConfiguration>
o
- object to compare topublic int hashCode()
hashCode
in class CompoundConfiguration<ToolboxConfiguration>
public String toString(boolean includeSources)
public ToolboxFactory createFactory()
Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.