A B C D E F G H I J K L M N O P Q R S T U V W X

A

AbstractTextDataLoader - Class in fmpp.dataloaders
Returns a string based on a plain text file.
AbstractTextDataLoader() - Constructor for class fmpp.dataloaders.AbstractTextDataLoader
 
add(String, Object) - Method in class fmpp.setting.Settings
Adds a setting value.
add(Map) - Method in class fmpp.setting.Settings
Adds all name-value pairs stored in the map with Settings.add(String, Object).
addConfiguredBorders(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredData(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredFreemarkerLinks(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredLocalData(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredModes(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredTurns(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addConfiguredXmlRenderings(AntTask.AntAttributeSubstitution) - Method in class fmpp.tools.AntTask
 
addData(String, Object) - Method in class fmpp.Engine
Adds a variable that will be visible for all templates when the processing session executes.
addData(String, byte) - Method in class fmpp.Engine
Convenience method for adding a Byte object.
addData(String, short) - Method in class fmpp.Engine
Convenience method for adding a Short object.
addData(String, int) - Method in class fmpp.Engine
Convenience method for adding a Integer object.
addData(String, long) - Method in class fmpp.Engine
Convenience method for adding a Long object.
addData(String, float) - Method in class fmpp.Engine
Convenience method for adding a Float object.
addData(String, double) - Method in class fmpp.Engine
Convenience method for adding a Double object.
addData(String, char) - Method in class fmpp.Engine
Convenience method for adding a Character object.
addData(String, boolean) - Method in class fmpp.Engine
Convenience method for adding a Boolean object.
addData(Map) - Method in class fmpp.Engine
Adds all entries with Engine.addData(String, Object).
addDefault(String, Object) - Method in class fmpp.setting.Settings
Adds a setting value with low priority.
addDefaults(Map) - Method in class fmpp.setting.Settings
Adds all entries stored in the map with Settings.addDefault(String, Object).
addDefaultsWithStrings(Properties) - Method in class fmpp.setting.Settings
Same as Settings.addDefaults(Map), but uses a Properties object, so the values are strings.
addDefaultWithString(String, String) - Method in class fmpp.setting.Settings
Same as Settings.addDefault(String, Object), but uses string value.
addDocumentElement(String, String) - Method in class fmpp.XmlRenderingConfiguration
Adds an element to the list of document elements.
addFooterChooser(String, String) - Method in class fmpp.Engine
Deprecated. Use Engine.addFooterChooser(int, String, String) instead.
addFooterChooser(int, String, String) - Method in class fmpp.Engine
Adds a new entry to the end of path-pattern->footer mapping list of the given layer.
addFreemarkerLink(String, File) - Method in class fmpp.Engine
Adds a FreeMarker link.
addHeaderChooser(String, String) - Method in class fmpp.Engine
Deprecated. Use Engine.addHeaderChooser(int, String, String) instead.
addHeaderChooser(int, String, String) - Method in class fmpp.Engine
Adds a new entry to the end of path-pattern->header mapping list of the given layer.
addList(List) - Method in class fmpp.util.MultiListIterator
Use this to add more lists after the constructor.
addLocalDataBuilder(int, String, LocalDataBuilder) - Method in class fmpp.Engine
Adds a local data builder.
addLocalDataBuilder(LocalDataBuilder) - Method in class fmpp.XmlRenderingConfiguration
Adds an extra local data builder that is invoked after all other local data builders.
addModeChooser(String, int) - Method in class fmpp.Engine
Adds a new entry to the end of path-pattern->processing-mode mapping list.
addOption(String, String) - Method in class fmpp.util.ArgsParser
Defines an option for the parser.
addProgressListener(ProgressListener) - Method in class fmpp.Engine
Adds a progress listener to the list of progress listeners.
addProgressListener(ProgressListener) - Method in class fmpp.setting.Settings
Adds a progress listener.
addRemoveExtension(String) - Method in class fmpp.Engine
Adds an extension to the list of extensions to remove.
addRemovePostfix(String) - Method in class fmpp.Engine
Adds a postfix to the list of file name postfixes to remove.
addReplaceExtension(String, String) - Method in class fmpp.Engine
Adds an old-exension -> new-extension pair to the list of extension replacements.
addSourcePathPattern(String) - Method in class fmpp.XmlRenderingConfiguration
Adds a path to the list of source path patterns.
addText(String) - Method in class fmpp.tools.AntTask.AntAttributeSubstitution
 
AddTransform - Class in fmpp.models
Adds/inserts an item to a WritableSequence.
AddTransform() - Constructor for class fmpp.models.AddTransform
 
addTurnChooser(String, int) - Method in class fmpp.Engine
Adds a new entry to the end of path-pattern->turn-number mapping list.
addWithString(String, String) - Method in class fmpp.setting.Settings
Same as Settings.add(String, Object), but uses string value.
addWithStrings(Properties) - Method in class fmpp.setting.Settings
Same as Settings.add(Map), but uses a Properties object, so the values are strings.
addXmlDataLoaderOption(String, Object) - Method in class fmpp.XmlRenderingConfiguration
Adds or replaces an option in the map of xml data loader options.
addXmlRenderingConfiguration(XmlRenderingConfiguration) - Method in class fmpp.Engine
Adds as XML rendering configuration.
AntDataLoader - Class in fmpp.dataloaders
Abstract base class of Ant related data loaders.
AntDataLoader() - Constructor for class fmpp.dataloaders.AntDataLoader
 
AntProgressListener - Class in fmpp.progresslisteners
Designed to show the progress for Ant tasks.
AntProgressListener(Task) - Constructor for class fmpp.progresslisteners.AntProgressListener
Output will be printed to the stdout.
AntProgressListener(Task, boolean) - Constructor for class fmpp.progresslisteners.AntProgressListener
 
AntProjectDataLoader - Class in fmpp.dataloaders
Returns the Ant project object.
AntProjectDataLoader() - Constructor for class fmpp.dataloaders.AntProjectDataLoader
 
AntPropertiesDataLoader - Class in fmpp.dataloaders
Returns the Map of all Ant properties, or of the selected Ant properties.
AntPropertiesDataLoader() - Constructor for class fmpp.dataloaders.AntPropertiesDataLoader
 
AntPropertyDataLoader - Class in fmpp.dataloaders
Returns the value of an Ant property.
AntPropertyDataLoader() - Constructor for class fmpp.dataloaders.AntPropertyDataLoader
 
AntTask - Class in fmpp.tools
Ant task to process files selected by pattern sets.
AntTask() - Constructor for class fmpp.tools.AntTask
 
AntTask.AntAttributeSubstitution - Class in fmpp.tools
Used internally (must be public class for technical reasons).
AntTask.AntAttributeSubstitution() - Constructor for class fmpp.tools.AntTask.AntAttributeSubstitution
 
AntTaskDataLoader - Class in fmpp.dataloaders
Returns the FMPP Ant task object.
AntTaskDataLoader() - Constructor for class fmpp.dataloaders.AntTaskDataLoader
 
args - Variable in class fmpp.dataloaders.FileDataLoader
 
ArgsParser - Class in fmpp.util
Simple command-line argument parser that mimics the logic of UN*X tools as ls.
ArgsParser() - Constructor for class fmpp.util.ArgsParser
Creates a parser.
ArgsParser.BadArgsException - Exception in fmpp.util
The user has entered invalid options in the command-line.
ArgsParser.OptionDefinition - Class in fmpp.util
Describes and option.
ArgsParser.OptionDefinition() - Constructor for class fmpp.util.ArgsParser.OptionDefinition
 
ATTRIBUTE_ANT_TASK - Static variable in class fmpp.dataloaders.AntDataLoader
The name of the Engine attribute that must store the Ant task object.

B

beginNestedOutputFile(String) - Method in class fmpp.TemplateEnvironment
It does the same as the begin tag of the corresponding directive of the pp hash.
beginNestedOutputFile(String, boolean) - Method in class fmpp.TemplateEnvironment
It does the same as the begin tag of the corresponding directive of the pp hash.
boolParam(Object, String) - Method in class fmpp.models.TemplateModelUtils
 
BorderedReader - Class in fmpp.util
Reader that can insert a string before and after an encapsulated character stream.
BorderedReader(String, Reader, String) - Constructor for class fmpp.util.BorderedReader
 
BshLocalDataBuilder - Class in fmpp.localdatabuilders
Deduces the file name of a BeanShell scrip file from the source file name, and executes that script to create local data.
BshLocalDataBuilder() - Constructor for class fmpp.localdatabuilders.BshLocalDataBuilder
Creates new instance.
BugException - Exception in fmpp.util
A bug has been detected.
BugException(String) - Constructor for exception fmpp.util.BugException
 
BugException(String, Throwable) - Constructor for exception fmpp.util.BugException
 
build(Engine, TemplateEnvironment) - Method in interface fmpp.LocalDataBuilder
Returns the variables that could be added to the local data.
build(Engine, TemplateEnvironment) - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
 
build(Engine, TemplateEnvironment) - Method in class fmpp.localdatabuilders.CachingLocalDataBuilder
Takes care of caching, and calls CachingLocalDataBuilder.build(Engine) if no cached result is available.
build(Engine) - Method in class fmpp.localdatabuilders.CachingLocalDataBuilder
Override this method in your local data builder class.
build(Engine, TemplateEnvironment) - Method in class fmpp.localdatabuilders.MapLocalDataBuilder
 
build(Engine) - Method in class fmpp.localdatabuilders.TddHashLocalDataBuilder
 
build(Engine, Template, File) - Method in interface fmpp.TemplateDataModelBuilder
Deprecated. Returns the top-level variables that will be avilable for the template.

C

CachingLocalDataBuilder - Class in fmpp.localdatabuilders
Stores the returned Map, and reuses it CachingLocalDataBuilder.build(Engine, TemplateEnvironment) is invoked again during the same processing session.
CachingLocalDataBuilder() - Constructor for class fmpp.localdatabuilders.CachingLocalDataBuilder
 
causeMessages(Throwable) - Static method in class fmpp.util.MiscUtil
This is the same as MiscUtil.causeTrace(java.lang.Throwable), but it doesn't print the exception class name if the class is inside an fmpp package.
causeTrace(Throwable) - Static method in class fmpp.util.MiscUtil
Returns the cause trace of an exception.
changeOutputFile(String) - Method in class fmpp.TemplateEnvironment
It does the same as the directive in the pp hash.
changeOutputFile(String, boolean) - Method in class fmpp.TemplateEnvironment
It does the same as the directive in the pp hash.
checkXmlSupportAvailability(String) - Method in class fmpp.Engine
Checks if XML support is available.
checkXmlSupportAvailability(String) - Static method in class fmpp.util.MiscUtil
Checks if XML API-s (JAXP, SAX2, DOM) are present.
chomp(String) - Static method in class fmpp.util.StringUtil
Removes the line-break from the end of the string.
chomp(StringBuffer) - Static method in class fmpp.util.StringUtil
Removes the line-break from the end of the StringBuffer.
classForName(String) - Static method in class fmpp.util.MiscUtil
Tries to load the class with the current context class loader, and only then with the current defining class loader.
clearAttribues() - Method in class fmpp.Engine
Removes all attributes.
clearAttribues() - Method in class fmpp.setting.Settings
Removes all engine attributes.
clearData() - Method in class fmpp.Engine
Removes all data.
clearDocumentElements() - Method in class fmpp.XmlRenderingConfiguration
Empties the document element list.
clearFooterChoosers() - Method in class fmpp.Engine
Removes all footer choosers.
clearFreemarkerLinks() - Method in class fmpp.Engine
Removes all FreeMarker links.
clearHeaderChoosers() - Method in class fmpp.Engine
Removes all header choosers.
clearLocalDataBuilders() - Method in class fmpp.Engine
Removes all local data builders.
clearLocalDataBuilders() - Method in class fmpp.XmlRenderingConfiguration
Removes all local data builders.
clearModeChoosers() - Method in class fmpp.Engine
Removes all processing mode choosers.
clearProgressListeners() - Method in class fmpp.Engine
Removes all progress listeners from the list of progress listeners that were added with Engine.addProgressListener(fmpp.ProgressListener).
clearProgressListeners() - Method in class fmpp.setting.Settings
Removes all progress listeneres.
clearRemoveExtensions() - Method in class fmpp.Engine
 
clearRemovePostfixes() - Method in class fmpp.Engine
 
clearReplaceExtensions() - Method in class fmpp.Engine
 
clearSharedVariables() - Method in class fmpp.Engine
Deprecated. Use Engine.clearData() instead.
clearSourcePathPatterns() - Method in class fmpp.XmlRenderingConfiguration
Empties the list of source path patterns.
ClearTransform - Class in fmpp.models
Removes all items from a WritableSequence or WritableHash.
ClearTransform() - Constructor for class fmpp.models.ClearTransform
 
clearTurnChoosers() - Method in class fmpp.Engine
Removes all turn choosers.
clearXmlDataLoaderOptions() - Method in class fmpp.XmlRenderingConfiguration
Removes all xml data loader options.
clearXmlRenderingConfigurations() - Method in class fmpp.Engine
Removes all XML rendering configurations.
clone() - Method in class fmpp.models.WritableHash
 
clone() - Method in class fmpp.models.WritableSequence
 
close() - Method in class fmpp.progresslisteners.LoggerProgressListener
Closes the PrintWriter used for printing into the log.
close() - Method in class fmpp.util.BorderedReader
 
close() - Method in class fmpp.util.NullWriter
 
CommandLine - Class in fmpp.tools
Command-line tool for preprocessing single files or entire directories.
CommandLine() - Constructor for class fmpp.tools.CommandLine
 
compressPath(String, int) - Static method in class fmpp.util.FileUtil
Returns a compressed version of the path.
ConsoleProgressListener - Class in fmpp.progresslisteners
Designed to show the progress on console screen.
ConsoleProgressListener() - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
Output will be printed to the stdout.
ConsoleProgressListener(OutputStream) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
 
ConsoleProgressListener(PrintWriter) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
 
ConsoleProgressListener(OutputStream, boolean) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
 
ConsoleProgressListener(PrintWriter, boolean) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
 
copy(String, String) - Method in class fmpp.util.ArgsParser.OptionDefinition
Creates a copy of the option with different short- and long-name, but with the same property name (and other attributes).
copyFile(File, File, boolean) - Static method in class fmpp.util.FileUtil
Copies a file; silently overwrites the destionation if already exists.
copyFile(File, File) - Static method in class fmpp.util.FileUtil
Same as copyFile(src, dst, true)).
CopyWritableVariableMethod - Class in fmpp.models
Creates a new, empty WritableHash.
CopyWritableVariableMethod() - Constructor for class fmpp.models.CopyWritableVariableMethod
 
createInstanceForSetting(String, List) - Static method in class fmpp.localdatabuilders.BshLocalDataBuilder
 
createSourceCodeErrorMessage(String, String, int, String, int) - Static method in class fmpp.util.StringUtil
 
CsvDataLoader - Class in fmpp.dataloaders
Data loaders that loads CSV (Column Separated Values) files or other files of similar formats (as tab divided text), and returns a fmpp.models.CsvSequence object.
CsvDataLoader() - Constructor for class fmpp.dataloaders.CsvDataLoader
 
CsvSequence - Class in fmpp.models
Sequence variable implementation that wraps text of CSV or tab separated values format, or any other format that is the same as CSV except that it uses different column separator char.
CsvSequence() - Constructor for class fmpp.models.CsvSequence
Creates a new instance.

D

dataFile - Variable in class fmpp.dataloaders.FileDataLoader
 
DataLoader - Interface in fmpp.tdd
Creates an object that will be accessed in FreeMarker templates.
DataLoaderEvaluationEnvironment - Class in fmpp.tdd
Evaluates function calls as data loader invocations.
DataLoaderEvaluationEnvironment(Engine) - Constructor for class fmpp.tdd.DataLoaderEvaluationEnvironment
 
DataLoaderUtil - Class in fmpp.util
Utility methods for writing data loaders.
DataLoaderUtil() - Constructor for class fmpp.util.DataLoaderUtil
 
DataModelBuildingException - Exception in fmpp
Error while trying to build the data-model for a template.
DataModelBuildingException(Throwable) - Constructor for exception fmpp.DataModelBuildingException
 
DataModelBuildingException(String) - Constructor for exception fmpp.DataModelBuildingException
 
DataModelBuildingException(String, Throwable) - Constructor for exception fmpp.DataModelBuildingException
 
DEFAULT_CFG_FILE_NAME - Static variable in class fmpp.setting.Settings
Primary default file name.
DEFAULT_CFG_FILE_NAME_OLD - Static variable in class fmpp.setting.Settings
Secondary (legacy) default file name.
defaultArg(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
Gives default argument value for an option that supports arguments, thus it will be optional to specify the argument value in the command-line.
define(String, Settings.SettingType, boolean, boolean) - Method in class fmpp.setting.Settings
Defines a new setting.
desc(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
Sets the description (used in help) of the option.
dictionaryToMap(Dictionary) - Static method in class fmpp.util.MiscUtil
 
dieWithMissingParam(String) - Method in class fmpp.models.TemplateModelUtils
 
dieWithParamsNotAllowed() - Method in class fmpp.models.TemplateModelUtils
 
dieWithUnknownParam(String) - Method in class fmpp.models.TemplateModelUtils
 
doProcessing(Engine, File[], File, File) - Method in class fmpp.setting.Settings
Executes the processing session(s) on the Engine level, using the already initialized Engine object.
dropOutputFile() - Method in class fmpp.TemplateEnvironment
It does the same as the directive in the pp hash.
dump() - Method in class fmpp.setting.Settings
Dumps the current content of this object for debugging purposes.
dump(Object) - Static method in class fmpp.tdd.Interpreter
Converts an object to a TDD-like representation (not necessary valid TDD).

E

EMPTY_CLASS_ARRAY - Static variable in class fmpp.util.MiscUtil
 
EMPTY_OBJECT_ARRAY - Static variable in class fmpp.util.MiscUtil
 
EMPTY_STRING_ARRAY - Static variable in class fmpp.util.MiscUtil
 
endNestedOutputFile() - Method in class fmpp.TemplateEnvironment
It does the same as the end tag of the corresponding directive of the pp hash.
engine - Variable in class fmpp.dataloaders.FileDataLoader
 
Engine - Class in fmpp
The bare-bone, low-level preprocessor engine.
Engine() - Constructor for class fmpp.Engine
Same as Engine(null).
Engine(BeansWrapper) - Constructor for class fmpp.Engine
Creates a new FMPP engine instance.
eval(String, EvaluationEnvironment, boolean, String) - Static method in class fmpp.tdd.Interpreter
Evaluates text as single TDD expression.
eval(Fragment, EvaluationEnvironment, boolean) - Static method in class fmpp.tdd.Interpreter
Evaluates a Fragment as single TDD expression.
eval(String, String) - Static method in class fmpp.tdd.Interpreter
Same as eval(text, null, false, fileName).
eval(String) - Static method in class fmpp.tdd.Interpreter
Same as eval(text, null, false, null).
evalAsHash(String, EvaluationEnvironment, boolean, String) - Static method in class fmpp.tdd.Interpreter
Evaluates text as a list of key:value pairs.
evalAsHash(String) - Static method in class fmpp.tdd.Interpreter
Same as evalAsHash(text, null, false, null).
evalAsHash(String, String) - Static method in class fmpp.tdd.Interpreter
Same as evalAsHash(text, null, false, fileName).
evalAsSequence(String, EvaluationEnvironment, boolean, String) - Static method in class fmpp.tdd.Interpreter
Evaluates text as a list values.
evalAsSequence(String) - Static method in class fmpp.tdd.Interpreter
Same as evalAsList(text, null, false, null).
evalAsSequence(String, String) - Static method in class fmpp.tdd.Interpreter
Same as evalAsList(text, null, false, fileName).
EvalDataLoader - Class in fmpp.dataloaders
Evaluates a BeanShell expression (looks like as Java).
EvalDataLoader() - Constructor for class fmpp.dataloaders.EvalDataLoader
 
EvalException - Exception in fmpp.tdd
 
EvalException(String) - Constructor for exception fmpp.tdd.EvalException
 
EvalException(String, Throwable) - Constructor for exception fmpp.tdd.EvalException
 
EvalException(String, int) - Constructor for exception fmpp.tdd.EvalException
 
EvalException(String, int, Throwable) - Constructor for exception fmpp.tdd.EvalException
 
EvalException(String, String, int, String) - Constructor for exception fmpp.tdd.EvalException
 
EvalException(String, String, int, String, Throwable) - Constructor for exception fmpp.tdd.EvalException
 
evalFunctionCall(FunctionCall, Interpreter) - Method in class fmpp.tdd.DataLoaderEvaluationEnvironment
 
evalFunctionCall(FunctionCall, Interpreter) - Method in interface fmpp.tdd.EvaluationEnvironment
Evaluates the function call.
EvaluationEnvironment - Interface in fmpp.tdd
Callbacks that let you control the behaviour of TDD expression evaluation.
EVENT_BEGIN_FILE_PROCESSING - Static variable in interface fmpp.ProgressListener
The processing of a single file has been started.
EVENT_BEGIN_PROCESSING_SESSION - Static variable in interface fmpp.ProgressListener
Engine.process has started the work.
EVENT_END_FILE_PROCESSING - Static variable in interface fmpp.ProgressListener
The processing of a single file has been finished.
EVENT_END_PROCESSING_SESSION - Static variable in interface fmpp.ProgressListener
Engine.process has finished the work.
EVENT_ENTER_FUNCTION_PARAMS - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have started to evaluate the parameter list in a function call.
EVENT_ENTER_HASH - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have started to evaluate the items in a hash.
EVENT_ENTER_HASH_KEY - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have started to evaluate the value in a key:value pair.
EVENT_ENTER_SEQUENCE - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have started to evaluate the items in a sequence.
EVENT_IGNORING_DIR - Static variable in interface fmpp.ProgressListener
A source directory has been ignored (skipped.)
EVENT_LEAVE_FUNCTION_PARAMS - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have finished to evaluate the parameter list in a function call.
EVENT_LEAVE_HASH - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have finished to evaluate the items in a sequence.
EVENT_LEAVE_HASH_KEY - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have finished to evaluate the value in a key:value pair.
EVENT_LEAVE_SEQUENCE - Static variable in interface fmpp.tdd.EvaluationEnvironment
The code of event that indicates that we have finished to evaluate the items in a sequence.
EVENT_SOURCE_NOT_MODIFIED - Static variable in interface fmpp.ProgressListener
The processing of source was skipped because the output was generated after the last modification of the source file.
EVENT_WARNING - Static variable in interface fmpp.ProgressListener
A warning message has been received from a template or from the engine.
ExceptionCC - Exception in fmpp.util
Exception that emulates J2SE 1.4+ cause-chains if it runs on earlier versions.
ExceptionCC() - Constructor for exception fmpp.util.ExceptionCC
 
ExceptionCC(String) - Constructor for exception fmpp.util.ExceptionCC
 
ExceptionCC(Throwable) - Constructor for exception fmpp.util.ExceptionCC
 
ExceptionCC(String, Throwable) - Constructor for exception fmpp.util.ExceptionCC
 
exec(List) - Method in class fmpp.models.CopyWritableVariableMethod
 
exec(List) - Method in class fmpp.models.NewWritableHashMethod
 
exec(List) - Method in class fmpp.models.NewWritableSequenceMethod
 
execute() - Method in class fmpp.setting.Settings
Executes a processing session based on the setting values.
execute(Engine) - Method in class fmpp.setting.Settings
Deprecated. This method will be soon removed; use Settings.execute() instead. Reusing the same engine object for multiple execute(...) calls is error-prone (because engine parameters set for earlier setting values may remain in effect, which is seldom useful, and surprising for most users). Also, this method is not compatible with new methods as Settings.addProgressListener(fmpp.ProgressListener), Settings.setEngineAttribute(String, Object), Settings.doProcessing(fmpp.Engine, java.io.File[], java.io.File, java.io.File), ...etc.
execute() - Method in class fmpp.tools.AntTask
 
execute(String[], PrintWriter, PrintWriter) - Static method in class fmpp.tools.CommandLine
Emulates command-line invocation of the tool.
expandTabs(String, int) - Static method in class fmpp.util.StringUtil
Same as expandTabs(text, tabWidth, 0).
expandTabs(String, int, int) - Static method in class fmpp.util.StringUtil
Replaces all occurances of character tab with spaces.

F

FileDataLoader - Class in fmpp.dataloaders
Ancestor of data loaders that create the result based on a file.
FileDataLoader() - Constructor for class fmpp.dataloaders.FileDataLoader
 
FileUtil - Class in fmpp.util
Collection of file and path related functions.
FileUtil() - Constructor for class fmpp.util.FileUtil
 
FileWithConfigurationBase - Class in fmpp.setting
File that stores the current configuration base directory at the time it was instantiated.
FileWithConfigurationBase(File, String, String) - Constructor for class fmpp.setting.FileWithConfigurationBase
Creates a new instance.
FileWithSettingValue - Class in fmpp.setting
File that stores the original setting value (string) it was constructed from.
FileWithSettingValue(File, String, String) - Constructor for class fmpp.setting.FileWithSettingValue
 
FileWithSettingValue(String, String) - Constructor for class fmpp.setting.FileWithSettingValue
 
FileWithSettingValue(String, String, String) - Constructor for class fmpp.setting.FileWithSettingValue
 
findObject(List, Object) - Static method in class fmpp.util.MiscUtil
Returns the first index of the given object (exactly the same instance) in the list.
findTopLevelVariable(String) - Method in class fmpp.tdd.DataLoaderEvaluationEnvironment
Override this to help TDD get function to find top level variables.
fixBoolean(String) - Method in class fmpp.models.CsvSequence
Override this if you want to correct boolean values come from the file.
fixNumber(String) - Method in class fmpp.models.CsvSequence
Override this if you want to correct numerical values come from the file.
fixVersion08SettingNames(Properties) - Static method in class fmpp.setting.Settings
Backward compatibility hack: renames properties that use pre-FMPP 0.9.0 names of settings.
flush() - Method in class fmpp.progresslisteners.LoggerProgressListener
Flushes the PrintWriter used for printing into the log.
flush() - Method in class fmpp.util.NullWriter
 
fmpp - package fmpp
The very core, the foundation of FMPP.
fmpp.dataloaders - package fmpp.dataloaders
fmpp.DataLoader implementations.
fmpp.localdatabuilders - package fmpp.localdatabuilders
fmpp.LocalDataBuilder implementations.
fmpp.models - package fmpp.models
freemarker.template.TemplateModel implementations.
fmpp.progresslisteners - package fmpp.progresslisteners
fmpp.ProgressListener implementations.
fmpp.setting - package fmpp.setting
FMPP settings.
fmpp.tdd - package fmpp.tdd
Textual Data Definition related classes.
fmpp.tools - package fmpp.tools
Tools (front-ends) that end-user can use out-of-the-box.
fmpp.util - package fmpp.util
Collection of more-less FMPP independent utility classes.
Fragment - Class in fmpp.tdd
Fragment extracted from a TDD expression.
Fragment(String, int, int, String) - Constructor for class fmpp.tdd.Fragment
Creates new TDD fragment.
FreemarkerUtil - Class in fmpp.util
FreeMarker related utilities.
FreemarkerUtil() - Constructor for class fmpp.util.FreemarkerUtil
 
ftlStringLiteralDec(String) - Static method in class fmpp.util.StringUtil
FTL string literal decoding. \\, \", \', \n, \t, \r, \b and \f will be replaced according to Java rules.
ftlVarToCoreJavaObject(TemplateModel) - Static method in class fmpp.util.FreemarkerUtil
Converts TemplateModel-s to java.util.
FunctionCall - Class in fmpp.tdd
Symbolizes a TDD function call.
FunctionCall(String, List) - Constructor for class fmpp.tdd.FunctionCall
 

G

get(int) - Method in class fmpp.models.CsvSequence
 
get(String) - Method in class fmpp.models.CsvSequence
 
get(int) - Method in class fmpp.models.StringArraySequence
 
get(int) - Method in class fmpp.models.TemplateModelListSequence
 
get(String) - Method in class fmpp.models.WritableHash
 
get(int) - Method in class fmpp.models.WritableSequence
 
get(String) - Method in class fmpp.setting.Settings
Gets the current value of a setting.
getAccessed() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of files that the engine has tried to process.
getAltFalse() - Method in class fmpp.models.CsvSequence
 
getAltTrue() - Method in class fmpp.models.CsvSequence
 
getArgName() - Method in class fmpp.util.ArgsParser.OptionDefinition
Returns the name of the argument, or null if the option does not support argument.
getAttribute(String) - Method in class fmpp.Engine
Reads an engine attribute.
getBooleanArgument(int, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getBooleanOption(String, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getBuildInfo() - Static method in class fmpp.Engine
Returns FMPP build info.
getCaseSensitive() - Method in class fmpp.Engine
 
getCause() - Method in exception fmpp.util.ExceptionCC
 
getCause() - Method in exception fmpp.util.RuntimeExceptionCC
 
getCauseException(Throwable) - Static method in class fmpp.util.MiscUtil
 
getCharArgument(int, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getCharOption(String, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getConfigurationBase() - Method in class fmpp.setting.FileWithConfigurationBase
 
getCopied() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of files successfully copied.
getCurrentInstance() - Static method in class fmpp.TemplateEnvironment
Returns the TemplateEnvironment object used for the template currently being executed by FMPP in the current thread.
getDashedName(String) - Static method in class fmpp.setting.Settings
Converts mixed-case setting name to dashed form, as sourceRoot to source-root.
getData(String) - Method in class fmpp.Engine
Gets the value of a variable.
getData(String) - Method in class fmpp.TemplateEnvironment
Similar to Engine.getData(java.lang.String), but it also sees file processing specifict variables (local data).
getDataLoaderInstance(Engine, String) - Static method in class fmpp.tdd.TddUtil
Resolves a data loader name to a data loader instance.
getDataRoot() - Method in class fmpp.Engine
Returns the directory used as data root directory.
getDateFormat() - Method in class fmpp.Engine
 
getDateFormatPattern() - Method in class fmpp.models.CsvSequence
 
getDateTimeFormat() - Method in class fmpp.Engine
 
getDateTimeFormatPattern() - Method in class fmpp.models.CsvSequence
 
getDecimalSeparator() - Method in class fmpp.models.CsvSequence
 
getDefaultArg() - Method in class fmpp.util.ArgsParser.OptionDefinition
Returns the default argument of the option, or null if the option has no default argument.
getDefaultConfigurationFile(File) - Static method in class fmpp.setting.Settings
Returns the default configuration file in the directory.
getDescription() - Method in class fmpp.util.ArgsParser.OptionDefinition
Returns the description of the option, or null if no description is available.
getEmptyValues() - Method in class fmpp.models.CsvSequence
 
getEncoding() - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
 
getEnding() - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
 
getEngine() - Method in class fmpp.TemplateEnvironment
Returns the FMPP engine object in use.
getEngineAttribute(String) - Method in class fmpp.setting.Settings
Reads an engine attribute.
getErrorCount() - Method in class fmpp.progresslisteners.AntProgressListener
 
getEvaluationEnvironment() - Method in class fmpp.tdd.Interpreter
 
getExecuted() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of files successfully executed (templates).
getExpertMode() - Method in class fmpp.Engine
 
getExternalHeaderRow() - Method in class fmpp.models.CsvSequence
 
getFailed() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of files where processing was failed.
getFileName() - Method in class fmpp.tdd.Fragment
Returns the name of the file the text comes from (for informational purposes only).
getFileName() - Method in class fmpp.tdd.Interpreter
 
getFragmentEnd() - Method in class fmpp.tdd.Fragment
Returns the end index (exclusive) of the fragment in the text.
getFragmentStart() - Method in class fmpp.tdd.Fragment
Returns the start index of the fragment in the text.
getFreemarkerEnvironment() - Method in class fmpp.TemplateEnvironment
Returns the FreeMarker environment currently in use.
getFreemarkerLink(String) - Method in class fmpp.Engine
Returns the list of files associated with a FreeMarker link name.
getFreeMarkerVersionNumber() - Static method in class fmpp.Engine
 
getGroupingSeparator() - Method in class fmpp.models.CsvSequence
 
getHasHeaderRow() - Method in class fmpp.models.CsvSequence
 
getHomePath() - Method in class fmpp.TemplateEnvironment
Returns URL-style path of the output root relative to the current output file.
getIgnoreCvsFiles() - Method in class fmpp.Engine
 
getIgnoreMissing() - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
Set if it will be ignored no script file found for the source file, rather than throwing an exception.
getIgnoreSvnFiles() - Method in class fmpp.Engine
 
getIgnoreTemporaryFiles() - Method in class fmpp.Engine
 
getIntArgument(int, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getIntOption(String, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getList() - Method in class fmpp.models.WritableSequence
 
getLocale() - Method in class fmpp.Engine
Returns the actual (non-null) locale in use.
getLongName() - Method in class fmpp.util.ArgsParser.OptionDefinition
Returns the long-name of the option, or null if the option has no long-name.
getMap() - Method in class fmpp.models.WritableHash
 
getMessage() - Method in exception fmpp.ProcessingException
Returns always the same text: "FMPP processing session failed."
getName() - Method in class fmpp.tdd.FunctionCall
 
getNames() - Method in class fmpp.setting.Settings
Lists the names of settings that were set.
getNonOptions() - Method in class fmpp.util.ArgsParser
Retruns the non-options resulting from the latest parse call.
getNormalizeHeaders() - Method in class fmpp.models.CsvSequence
 
getNumberFormat() - Method in class fmpp.Engine
 
getOldTemplateSyntax() - Method in class fmpp.Engine
 
getOption(String) - Method in class fmpp.util.ArgsParser
Convenience funtcion to read the option Properties object.
getOptionDefinition(String) - Method in class fmpp.util.ArgsParser
Returns the ArgsParser.OptionDefinition for the given option name.
getOptionDefintions() - Method in class fmpp.util.ArgsParser
Returns the list of ArgsParser.OptionDefinition-s, sorted as they should appear in an option help.
getOptions() - Method in class fmpp.util.ArgsParser
Returns the options resulting from the latest parse call as Properties object.
getOptionsHelp(int) - Method in class fmpp.util.ArgsParser
Generates options help for the defined options.
getOutputEncoding() - Method in class fmpp.Engine
Retruns the output encoding used; It can be "source" (since that can't be resolved to a concrete charset), but never null or "host".
getOutputEncoding() - Method in class fmpp.TemplateEnvironment
Returns the output encoding.
getOutputFile() - Method in class fmpp.TemplateEnvironment
Returns the output file.
getOutputRoot() - Method in class fmpp.Engine
Returns the output root directory.
getParams() - Method in class fmpp.tdd.FunctionCall
 
getPathTo(String) - Method in class fmpp.TemplateEnvironment
Calulates the path of another output file relatively to current output file, in UN*X format.
getPosition() - Method in class fmpp.tdd.Interpreter
 
getPrintWriter() - Method in class fmpp.progresslisteners.LoggerProgressListener
Returns the PrintWriter used for printing into the log.
getProcessingTime() - Method in class fmpp.progresslisteners.StatisticsProgressListener
The duration of the last BEGIN_ALL_PROCESSING-END_ALL_PROCESSING in milliseconds, or -1 if that is not known.
getProgressListenerEventName(int) - Static method in class fmpp.Engine
Converts an ProgressListener.EVENT_...
getPropertyNames() - Method in class fmpp.util.ArgsParser
Returns the property names used in the options.
getRelativePath(File, File) - Static method in class fmpp.util.FileUtil
Reaturns the path of a file or directory relative to a directory, in native format.
getRemoveExtension() - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
 
getSeparator() - Method in class fmpp.models.CsvSequence
 
getSettingValue() - Method in class fmpp.setting.FileWithSettingValue
 
getShortName() - Method in class fmpp.util.ArgsParser.OptionDefinition
Returns the short-name of the option, or null if the option has no short-name.
getSkipUnchanged() - Method in class fmpp.Engine
 
getSourceEncoding() - Method in class fmpp.Engine
Returns the source encoding used for the template files.
getSourceFile() - Method in exception fmpp.ProcessingException
Returns the source file the faliure relates to.
getSourceFile() - Method in class fmpp.TemplateEnvironment
Returns the source file.
getSourcePathTo(String) - Method in class fmpp.TemplateEnvironment
Same as TemplateEnvironment.getPathTo(java.lang.String) but with the source file and source root directory.
getSourceRoot() - Method in class fmpp.Engine
Returns the source root directory.
getSourceRoot() - Method in exception fmpp.ProcessingException
Returns the "sourceRoot" used during the processing session that failed.
getStandardSettingNames() - Static method in class fmpp.setting.Settings
Returns if the given name is the name of a standard setting.
getStopOnError() - Method in class fmpp.Engine
 
getStringArgument(int, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getStringArrayArgument(int, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getStringArrayArgument(int, Object, boolean) - Static method in class fmpp.util.DataLoaderUtil
 
getStringArrayOption(String, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getStringArrayOption(String, Object, boolean) - Static method in class fmpp.util.DataLoaderUtil
 
getStringOption(String, Object) - Static method in class fmpp.util.DataLoaderUtil
 
getSuccesful() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of files where processing was successfull.
getTagSyntax() - Method in class fmpp.Engine
 
getTarget() - Method in class fmpp.tools.AntTask
 
getTemplate() - Method in class fmpp.TemplateEnvironment
Retuns the FreeMarker Template object for the source file.
getTemplateDataModelBuilder() - Method in class fmpp.Engine
 
getTemplateEnvironment() - Method in class fmpp.Engine
Returns the TemplateEnvironment.
getText() - Method in class fmpp.tdd.Fragment
Returns the full TDD text that contains the fragmet.
getText() - Method in class fmpp.tdd.Interpreter
 
getText() - Method in class fmpp.tools.AntTask.AntAttributeSubstitution
 
getTimeFormat() - Method in class fmpp.Engine
 
getTimeFormatPattern() - Method in class fmpp.models.CsvSequence
 
getTimeZone() - Method in class fmpp.Engine
 
getTimeZone() - Method in class fmpp.models.CsvSequence
 
getTrimCells() - Method in class fmpp.models.CsvSequence
 
getTypeName(Object) - Static method in class fmpp.tdd.Interpreter
 
getUrlEscapingCharset() - Method in class fmpp.Engine
Retruns the output encoding used; It can be "output" (since that can't be resolved to a concrete charset), but never null.
getValidateXml() - Method in class fmpp.Engine
 
getVersionNumber() - Static method in class fmpp.Engine
Returns the FMPP version number string.
getWarnings() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Total number of warnings.
getWrappedObject() - Method in class fmpp.models.TemplateModelListSequence
 
getWrappedXmlDocument() - Method in class fmpp.TemplateEnvironment
The same as TemplateEnvironment.getXmlDocument(), but returns the document as freemarker.ext.dom.NodeModel.
getWriter(Writer, Map) - Method in class fmpp.models.AddTransform
 
getWriter(Writer, Map) - Method in class fmpp.models.ClearTransform
 
getWriter(Writer, Map) - Method in class fmpp.models.RemoveTransform
 
getWriter(Writer, Map) - Method in class fmpp.models.SetTransform
 
getXmlDocument() - Method in class fmpp.TemplateEnvironment
Returns the processed XML document (pp.doc) as org.w3c.dom.Document.
getXmlEntiryResolver() - Method in class fmpp.Engine
Gets the XML entiry resolver used for reading XML documents.
getXmlRendered() - Method in class fmpp.progresslisteners.StatisticsProgressListener
Number of XML files successfully rendered.
getXpathEngine() - Method in class fmpp.Engine
 
group(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
Convenience method; same as calling property(propertyName, optionName), where optionName is the long-name if that exists, otherwise the short-name.

H

hasNext() - Method in class fmpp.util.MultiListIterator
 
hide() - Method in class fmpp.util.ArgsParser.OptionDefinition
Hides option, that is, it will not be shown in the option help.
htmlEnc(String) - Static method in class fmpp.util.StringUtil
HTML encoding (does not convert line breaks).
HtmlUtilsDataLoader - Class in fmpp.dataloaders
Returns a hash that contains useful directives for HTML generation.
HtmlUtilsDataLoader() - Constructor for class fmpp.dataloaders.HtmlUtilsDataLoader
 

I

implied() - Method in class fmpp.util.ArgsParser.OptionDefinition
Ensures that the option will be seemingly present if the args[] does not contains this option or any other option that mutually excludes this option.
implied(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
Ensures that the option will be seemingly present with the given argument value if args[] does not contains this option, or any other option that mutually excludes this option.
InstallationException - Exception in fmpp.util
There is a problem with the software environment.
InstallationException(String) - Constructor for exception fmpp.util.InstallationException
 
InstallationException(String, Throwable) - Constructor for exception fmpp.util.InstallationException
 
INSTANCE - Static variable in class fmpp.util.NullOutputStream
 
INSTANCE - Static variable in class fmpp.util.NullWriter
 
Interpreter - Class in fmpp.tdd
Evaluates TDD expressions.
intParam(Object, String) - Method in class fmpp.models.TemplateModelUtils
 
isDefined(String) - Method in class fmpp.setting.Settings
Returns if a setting with the given name is defined (do not mix it up with being set).
isEmpty() - Method in class fmpp.models.CsvSequence
 
isEmpty() - Method in class fmpp.models.WritableHash
 
isInside(File, File) - Static method in class fmpp.util.FileUtil
Returns true if file is inside ascendant, otherwise returns false.
isInsideOrEquals(File, File) - Static method in class fmpp.util.FileUtil
Returns true if file is inside ascendant or file is the same as the ascendant, otherwise returns false.
isOptionName(String) - Static method in class fmpp.dataloaders.XmlDataLoader
Checks if the string is a valid xml data loader option name.
isTemplateEnvironmentAvailable() - Method in class fmpp.Engine
Tells if Engine.getTemplateEnvironment() will throw exception or not.
isXmlSupportAvailabile() - Method in class fmpp.Engine
Quickly tells if XML support is available.
iterator() - Method in class fmpp.models.TemplateModelArrayCollection
 
iterator() - Method in class fmpp.models.TemplateModelListCollection
 

J

jQuote(char) - Static method in class fmpp.util.StringUtil
Quotes string as Java language character.
jQuote(String) - Static method in class fmpp.util.StringUtil
Quotes string as Java language string literal.
jQuoteOrName(char) - Static method in class fmpp.util.StringUtil
Quotes string as Java language character, except quote characters, which are referred with name.

K

keys() - Method in class fmpp.models.WritableHash
 

L

LINE_BREAK - Static variable in class fmpp.util.StringUtil
The default line-break string used by the methods in this class.
listContainsObject(List, Object) - Static method in class fmpp.util.MiscUtil
Checks if the list contains the given object (exactly the same instance).
load(InputStream) - Method in class fmpp.dataloaders.AbstractTextDataLoader
 
load(Engine, List) - Method in class fmpp.dataloaders.AntDataLoader
Gets the Ant task object, and invoked AntDataLoader.load(Engine, List, Task).
load(Engine, List, Task) - Method in class fmpp.dataloaders.AntDataLoader
Override this method to implement your Ant related data loader.
load(Engine, List, Task) - Method in class fmpp.dataloaders.AntProjectDataLoader
 
load(Engine, List, Task) - Method in class fmpp.dataloaders.AntPropertiesDataLoader
 
load(Engine, List, Task) - Method in class fmpp.dataloaders.AntPropertyDataLoader
 
load(Engine, List, Task) - Method in class fmpp.dataloaders.AntTaskDataLoader
 
load(InputStream) - Method in class fmpp.dataloaders.CsvDataLoader
 
load(Engine, List) - Method in class fmpp.dataloaders.EvalDataLoader
 
load(Engine, List) - Method in class fmpp.dataloaders.FileDataLoader
 
load(InputStream) - Method in class fmpp.dataloaders.FileDataLoader
FileDataLoader subclasess override this method to parse the file.
load(Engine, List) - Method in class fmpp.dataloaders.HtmlUtilsDataLoader
 
load(Engine, List) - Method in class fmpp.dataloaders.NowDataLoader
 
load(InputStream) - Method in class fmpp.dataloaders.PropertiesDataLoader
 
load(InputStream) - Method in class fmpp.dataloaders.TddDataLoader