Package fmpp
Interface LocalDataBuilder
-
- All Known Implementing Classes:
BshLocalDataBuilder
,CachingLocalDataBuilder
,MapLocalDataBuilder
,TddHashLocalDataBuilder
public interface LocalDataBuilder
Contains callback to build the local data for a file processing. This interface is used to implement the "localData" setting.Life-cycle: These are long-lived objects. The local data builder object is plugged into the
Engine
, and then it may be in use during several processing sessions. Typically the construction of the object is done bySettings.execute()
, based on the value of setting "localData".Local data builders that are added with setting "localData" (or directly with
Engine.addLocalDataBuilder(int, java.lang.String, fmpp.LocalDataBuilder)
) receive notifications about the events of theEngine
if they implement interfaceProgressListener
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map
build(Engine eng, TemplateEnvironment env)
Returns the variables that could be added to the local data.
-
-
-
Method Detail
-
build
java.util.Map build(Engine eng, TemplateEnvironment env) throws java.lang.Exception
Returns the variables that could be added to the local data.- Returns:
- the variables to add to the local data. Can be
null
. The returned map will not be modified (although technically, badly behaved 3rd party code can modify the values soted in the map...). - Throws:
java.lang.Exception
-
-