A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractTextDataLoader - Class in fmpp.dataloaders
-
Returns a string based on a plain text file.
- AbstractTextDataLoader() - Constructor for class fmpp.dataloaders.AbstractTextDataLoader
- add(String[], String[]) - Static method in class fmpp.util.MiscUtil
-
Concatenates two arrays.
- 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
- addConfiguredOutputFormatsByPath(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, boolean) - Method in class fmpp.Engine
-
Convenience method for adding a
Boolean
object. - addData(String, byte) - Method in class fmpp.Engine
-
Convenience method for adding a
Byte
object. - addData(String, char) - Method in class fmpp.Engine
-
Convenience method for adding a
Character
object. - addData(String, double) - Method in class fmpp.Engine
-
Convenience method for adding a
Double
object. - addData(String, float) - Method in class fmpp.Engine
-
Convenience method for adding a
Float
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, short) - Method in class fmpp.Engine
-
Convenience method for adding a
Short
object. - addData(String, Object) - Method in class fmpp.Engine
-
Adds a variable that will be visible for all templates when the processing session executes.
- 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 aProperties
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(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.
- addFooterChooser(String, String) - Method in class fmpp.Engine
-
Deprecated.Use
Engine.addFooterChooser(int, String, String)
instead. - addFreemarkerLink(String, File) - Method in class fmpp.Engine
-
Adds a FreeMarker link.
- 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.
- addHeaderChooser(String, String) - Method in class fmpp.Engine
-
Deprecated.Use
Engine.addHeaderChooser(int, String, String)
instead. - 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.
- addOutputFormatChooser(String, OutputFormat) - Method in class fmpp.Engine
-
Adds a new entry to the end of path-pattern -> output-format mapping list.
- 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 that will be interpreted bySettings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean)
. - addWithStrings(Properties) - Method in class fmpp.setting.Settings
-
Same as
Settings.add(Map)
, but uses aProperties
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.
- AntAttributeSubstitution() - Constructor for class fmpp.tools.AntTask.AntAttributeSubstitution
- 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).
- 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.
- 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) - Method in class fmpp.localdatabuilders.CachingLocalDataBuilder
-
Override this method in your local data builder class.
- build(Engine) - Method in class fmpp.localdatabuilders.TddHashLocalDataBuilder
- 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, TemplateEnvironment) - Method in class fmpp.localdatabuilders.MapLocalDataBuilder
- build(Engine, Template, File) - Method in interface fmpp.TemplateDataModelBuilder
-
Deprecated.Returns the top-level variables that will be available for the template.
C
- CachingLocalDataBuilder - Class in fmpp.localdatabuilders
-
Stores the returned
Map
, and reuses itCachingLocalDataBuilder.build(Engine, TemplateEnvironment)
is invoked again during the same processing session. - CachingLocalDataBuilder() - Constructor for class fmpp.localdatabuilders.CachingLocalDataBuilder
- capitalizeFirst(String) - Static method in class fmpp.util.StringUtil
- 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 anfmpp
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.
- clearOutputFormatChoosers() - Method in class fmpp.Engine
-
Removes all output format 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
orWritableHash
. - 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(OutputStream, boolean) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
- ConsoleProgressListener(PrintWriter) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
- ConsoleProgressListener(PrintWriter, boolean) - Constructor for class fmpp.progresslisteners.ConsoleProgressListener
- convert(Settings, Object) - Method in class fmpp.setting.Settings.SettingType
-
Converts an object to the type of the setting.
- convertToDataMap(Object) - Static method in class fmpp.tdd.TddUtil
-
Converts a value to
Map
, if it's possible, in a way that mostly useful when it will be used as part of the "data" setting. - 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) - Static method in class fmpp.util.FileUtil
-
Same as
copyFile(src, dst, true))
. - copyFile(File, File, boolean) - Static method in class fmpp.util.FileUtil
-
Copies a file; silently overwrites the destination if already exists.
- 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(String) - Constructor for exception fmpp.DataModelBuildingException
- DataModelBuildingException(String, Throwable) - Constructor for exception fmpp.DataModelBuildingException
- DataModelBuildingException(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.
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONArrayNode
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONBooleanNode
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONNullNode
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONNumberNode
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONObjectNode
- DEFAULT_NODE_NAME - Static variable in class fmpp.models.JSONStringNode
- DEFAULT_RECOMMENDED_DEFAULTS - Static variable in class fmpp.Engine
-
The default value of the
recommendDefaults
setting, whennull
is passed for it to theEngine
constructor. - 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
-
Deprecated.
- dieWithParamsNotAllowed() - Method in class fmpp.models.TemplateModelUtils
-
Deprecated.
- dieWithUnknownParam(String) - Method in class fmpp.models.TemplateModelUtils
-
Deprecated.
- doProcessing(Engine, File[], File, File) - Method in class fmpp.setting.Settings
-
Executes the processing session(s) on the
Engine
level, using the already initializedEngine
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
-
Deprecated.Use
Engine(Version)
instead. - Engine(BeansWrapper) - Constructor for class fmpp.Engine
-
Deprecated.Use
Engine(Version, Version, BeansWrapper)
instead. - Engine(BeansWrapper, Version) - Constructor for class fmpp.Engine
-
Deprecated.Use
Engine(Version, Version, BeansWrapper)
instead. - Engine(Version) - Constructor for class fmpp.Engine
- Engine(Version, Version, BeansWrapper) - Constructor for class fmpp.Engine
-
Creates a new FMPP engine instance.
- eval(Fragment, EvaluationEnvironment, boolean) - Static method in class fmpp.tdd.Interpreter
-
Evaluates a
Fragment
as single TDD expression. - eval(String) - Static method in class fmpp.tdd.Interpreter
-
Same as
eval(text, null, false, null)
. - eval(String, EvaluationEnvironment, boolean, String) - Static method in class fmpp.tdd.Interpreter
-
Evaluates text as single TDD expression.
- eval(String, String) - Static method in class fmpp.tdd.Interpreter
-
Same as
eval(text, null, false, fileName)
. - evalAsHash(String) - Static method in class fmpp.tdd.Interpreter
-
Same as
evalAsHash(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, String) - Static method in class fmpp.tdd.Interpreter
-
Same as
evalAsHash(text, null, false, fileName)
. - evalAsSequence(String) - Static method in class fmpp.tdd.Interpreter
-
Same as
evalAsList(text, null, false, null)
. - evalAsSequence(String, EvaluationEnvironment, boolean, String) - Static method in class fmpp.tdd.Interpreter
-
Evaluates text as a list values.
- 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, 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
- EvalException(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_CREATED_EMPTY_DIR - Static variable in interface fmpp.ProgressListener
-
An empty directory was created due to the copyEmptyDirs setting.
- 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
-
This was used for emulating cause-chains on Java earlier than 1.4, but as FMPP now requires 1.4, it just dispatches to
Exception
. - ExceptionCC() - Constructor for exception fmpp.util.ExceptionCC
- ExceptionCC(String) - Constructor for exception fmpp.util.ExceptionCC
- ExceptionCC(String, Throwable) - Constructor for exception fmpp.util.ExceptionCC
- ExceptionCC(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() - Method in class fmpp.tools.AntTask
- execute(String[], PrintWriter, PrintWriter) - Static method in class fmpp.tools.CommandLine
-
Emulates the 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
- finalizeResult(Object) - Method in class fmpp.dataloaders.JSONDataLoader
-
Converts the POJO created from the JSON to its final form.
- 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_CONSOLE_COLS - Static variable in class fmpp.tools.CommandLine
-
The number of console (terminal) columns can be passed in with this environment variable, supposedly by the OS-specific starter executable (shell script).
- 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.
- ftlVarToCoreJavaObject(TemplateModel) - Static method in class fmpp.util.FreemarkerUtil
-
Converts
TemplateModel
-s tojava.util.*
andjava.lang.*
objects. - 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(int) - Method in class fmpp.models.JSONArrayNode
- get(int) - Method in class fmpp.models.StringArraySequence
- get(int) - Method in class fmpp.models.TemplateModelListSequence
- get(int) - Method in class fmpp.models.WritableSequence
- get(String) - Method in class fmpp.models.CsvSequence
- get(String) - Method in class fmpp.models.JSONObjectNode
- get(String) - Method in class fmpp.models.WritableHash
- 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.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONArrayNode
-
Returns the plain Java object wrapped into this node.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONBooleanNode
-
Returns the plain Java object wrapped into this node.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONNullNode
-
Returns the plain Java object wrapped into this node.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONNumberNode
-
Returns the plain Java object wrapped into this node.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONObjectNode
-
Returns the plain Java object wrapped into this node.
- getAdaptedObject(Class<?>) - Method in class fmpp.models.JSONStringNode
-
Returns the plain Java object wrapped into this node.
- getAltFalse() - Method in class fmpp.models.CsvSequence
- getAltTrue() - Method in class fmpp.models.CsvSequence
- getAlwaysCreateDirectories() - Method in class fmpp.Engine
- getArgName() - Method in class fmpp.util.ArgsParser.OptionDefinition
-
Returns the name of the argument, or null if the option does not support argument.
- getAsBoolean() - Method in class fmpp.models.JSONBooleanNode
- getAsNumber() - Method in class fmpp.models.JSONNumberNode
- getAsString() - Method in class fmpp.models.JSONStringNode
- 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.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
- getChildNodes() - Method in class fmpp.models.JSONArrayNode
- getChildNodes() - Method in class fmpp.models.JSONBooleanNode
-
Always returns
null
. - getChildNodes() - Method in class fmpp.models.JSONNullNode
- getChildNodes() - Method in class fmpp.models.JSONNumberNode
-
Always returns
null
. - getChildNodes() - Method in class fmpp.models.JSONObjectNode
- getChildNodes() - Method in class fmpp.models.JSONStringNode
-
Always returns
null
. - 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, like 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 specific 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.
- getDefaultFreemarkerIncompatibleImprovements(Version) - Static method in class fmpp.Engine
-
The default value of the
freemarkerIncompatibleImprovements
setting, whennull
is passed for it to theEngine
constructor. - getDefaultNodeName() - Method in class fmpp.models.JSONArrayNode
- getDefaultNodeName() - Method in class fmpp.models.JSONBooleanNode
- getDefaultNodeName() - Method in class fmpp.models.JSONNode
-
Returns the name of the node if it has no explicit name.
- getDefaultNodeName() - Method in class fmpp.models.JSONNullNode
- getDefaultNodeName() - Method in class fmpp.models.JSONNumberNode
- getDefaultNodeName() - Method in class fmpp.models.JSONObjectNode
- getDefaultNodeName() - Method in class fmpp.models.JSONStringNode
- getDescription() - Method in class fmpp.util.ArgsParser.OptionDefinition
-
Returns the description of the option, or null if no description is available.
- getDontTraverseDirectories() - Method in class fmpp.Engine
- getDontTraverseDirectories() - Method in class fmpp.setting.Settings
- 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.
- getFileExtension(String) - Static method in class fmpp.util.FileUtil
-
Returns the part of the name after the last dot, or if there's no dot,
null
. - 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.
- getFreemarkerIncomplatibleImprovements() - Method in class fmpp.Engine
-
Returns the FreeMarker "incompatible improvements" setting.
- getFreemarkerLink(String) - Method in class fmpp.Engine
-
Returns the list of files associated with a FreeMarker link name.
- getFreeMarkerVersion() - Static method in class fmpp.Engine
-
Returns the FreeMarker version used.
- getFreeMarkerVersionNumber() - Static method in class fmpp.Engine
-
Deprecated.Use
Engine.getFreeMarkerVersion()
instead. If you have need aString
, it has a properVersion.toString()
. - 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
- getInterpolationSyntax() - Method in class fmpp.Engine
- 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.
- getLowerCaseFileExtension(String) - Static method in class fmpp.util.FileUtil
-
Same as
FileUtil.getFileExtension(String)
, but also converts the result to lower case. - getMap() - Method in class fmpp.models.WritableHash
- getMapCommonExtensionsToOutputFormats() - Method in class fmpp.Engine
-
Getter pair of
Engine.setMapCommonExtensionsToOutputFormats(boolean)
. - 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.
- getNodeName() - Method in class fmpp.models.JSONNode
-
Returns the same as
TemplateNodeModel.getNodeType()
, except when the node is the value in a key-value pair in a JSON object, in which case it returns the key value. - getNodeNamespace() - Method in class fmpp.models.JSONNode
- getNodeType() - Method in class fmpp.models.JSONArrayNode
-
Returns
JSONArrayNode.NODE_TYPE
. - getNodeType() - Method in class fmpp.models.JSONBooleanNode
-
Returns
JSONBooleanNode.NODE_TYPE
. - getNodeType() - Method in class fmpp.models.JSONNullNode
- getNodeType() - Method in class fmpp.models.JSONNumberNode
-
Returns
JSONNumberNode.NODE_TYPE
. - getNodeType() - Method in class fmpp.models.JSONObjectNode
- getNodeType() - Method in class fmpp.models.JSONStringNode
-
Returns
JSONStringNode.NODE_TYPE
. - 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 asProperties
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 nevernull
or"host"
. - getOutputEncoding() - Method in class fmpp.TemplateEnvironment
-
Returns the output encoding.
- getOutputFile() - Method in class fmpp.TemplateEnvironment
-
Returns the output file.
- getOutputFormat() - Method in class fmpp.Engine
-
Getter pair of
Engine.setOutputFormat(OutputFormat)
. - getOutputFormat(String) - Method in class fmpp.Engine
-
Resolves an FreeMarker "output format" name to an
OutputFormat
object. - getOutputRoot() - Method in class fmpp.Engine
-
Returns the output root directory.
- getParams() - Method in class fmpp.tdd.FunctionCall
- getParentNode() - Method in class fmpp.models.JSONNode
-
Returns the JSON "object" or JSON "array" that contains this value.
- getPathTo(String) - Method in class fmpp.TemplateEnvironment
-
Calculates 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_...
constant to English text. - getPropertyNames() - Method in class fmpp.util.ArgsParser
-
Returns the property names used in the options.
- getRecommendedDefaults() - Method in class fmpp.Engine
-
See the similarly named constructor parameter of
Engine(Version, Version, BeansWrapper)
. - 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
- getRemoveFreemarkerExtensions() - Method in class fmpp.Engine
-
Getter pair of
Engine.setRemoveFreemarkerExtensions(boolean)
. - 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 names of the standard (not user-defined) settings.
- 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 nevernull
. - getValidateXml() - Method in class fmpp.Engine
- getVersion() - Static method in class fmpp.Engine
-
Returns the FMPP version number.
- getVersionNumber() - Static method in class fmpp.Engine
-
Deprecated.
- 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 asNodeModel
. - 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
) asDocument
. - 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.JSONObjectNode
- isEmpty() - Method in class fmpp.models.WritableHash
- isInside(File, File) - Static method in class fmpp.util.FileUtil
-
Returns true if
file
is insideascendant
, otherwise returns false. - isInsideOrEquals(File, File) - Static method in class fmpp.util.FileUtil
-
Returns true if
file
is insideascendant
orfile
is the same as theascendant
, 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 character as Java language character, except quote characters, which are referred with name.
- JSONArrayNode - Class in fmpp.models
-
JSON "array" value; see http://www.json.org/.
- JSONArrayNode(JSONNode, String, List) - Constructor for class fmpp.models.JSONArrayNode
- JSONBooleanNode - Class in fmpp.models
-
JSON "true" and "false" value; see http://www.json.org/.
- JSONBooleanNode(JSONNode, String, boolean) - Constructor for class fmpp.models.JSONBooleanNode
- JSONDataLoader - Class in fmpp.dataloaders
-
Creates a
JSONNode
based on a JSON file. - JSONDataLoader() - Constructor for class fmpp.dataloaders.JSONDataLoader
- JSONNode - Class in fmpp.models
-
Node in a hierarchy of JSON values.
- JSONNode(JSONNode, String) - Constructor for class fmpp.models.JSONNode
- JSONNullNode - Class in fmpp.models
-
JSON "null" value; see http://www.json.org/.
- JSONNullNode(JSONNode, String) - Constructor for class fmpp.models.JSONNullNode
- JSONNumberNode - Class in fmpp.models
-
JSON "number" value; see http://www.json.org/.
- JSONNumberNode(JSONNode, String, Number) - Constructor for class fmpp.models.JSONNumberNode
- JSONObjectNode - Class in fmpp.models
-
JSON "object" value; see http://www.json.org/.
- JSONObjectNode(JSONNode, String, Map) - Constructor for class fmpp.models.JSONObjectNode
- JSONParseException - Exception in fmpp.util
- JSONParseException(String, String, int, String) - Constructor for exception fmpp.util.JSONParseException
- JSONParseException(String, String, int, String, Throwable) - Constructor for exception fmpp.util.JSONParseException
- JSONParser - Class in fmpp.util
-
Simple JSON parser where JSON objects create
Map
-s, JSON array-s createList
-s, and the others create the obvious Java equivalents. - JSONStringNode - Class in fmpp.models
-
JSON "string" value; see http://www.json.org/.
- JSONStringNode(JSONNode, String, String) - Constructor for class fmpp.models.JSONStringNode
K
- keys() - Method in class fmpp.models.JSONObjectNode
- keys() - Method in class fmpp.models.WritableHash
- keyValuePairIterator() - Method in class fmpp.models.JSONObjectNode
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(Engine, List) - Method in class fmpp.dataloaders.AntDataLoader
-
Gets the Ant task object, and invoked
AntDataLoader.load(Engine, List, Task)
. - load(Engine, List) - Method in class fmpp.dataloaders.EvalDataLoader
- load(Engine, List) - Method in class fmpp.dataloaders.FileDataLoader
- load(Engine, List) - Method in class fmpp.dataloaders.HtmlUtilsDataLoader
- load(Engine, List) - Method in class fmpp.dataloaders.NowDataLoader
- load(Engine, List) - Method in class fmpp.dataloaders.XmlDataLoader
- load(Engine, List) - Method in interface fmpp.tdd.DataLoader
- 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(Engine, List, Document) - Method in class fmpp.dataloaders.XmlDataLoader
- load(File) - Method in class fmpp.setting.Settings
-
Loads settings from a configuration file.
- load(InputStream) - Method in class fmpp.dataloaders.AbstractTextDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.CsvDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.FileDataLoader
-
FileDataLoader
subclasess override this method to parse the file. - load(InputStream) - Method in class fmpp.dataloaders.JSONDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.PropertiesDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.TddDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.TddSequenceDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.TextDataLoader
- load(InputStream) - Method in class fmpp.dataloaders.XmlInfosetDataLoader
-
Deprecated.
- load(Reader) - Method in class fmpp.models.CsvSequence
-
Loads data from text of CSV (or whatever similar) format.
- loadByteArray(InputStream) - Static method in class fmpp.util.FileUtil
- loadDefaults(File) - Method in class fmpp.setting.Settings
-
Same as
load
, except that it adds the settings withSettings.addDefaults(Map)
. - loadString(InputStream, String) - Static method in class fmpp.util.FileUtil
- loadTdd(byte[], String) - Static method in class fmpp.tdd.Interpreter
-
Loads a TDD file with utilizing #encoding:enc header.
- loadTdd(InputStream, String) - Static method in class fmpp.tdd.Interpreter
-
Loads a TDD file with utilizing #encoding:enc header.
- loadXmlFile(Engine, File, boolean, boolean) - Static method in class fmpp.dataloaders.XmlDataLoader
- loadXmlFile(Engine, File, boolean, boolean, boolean) - Static method in class fmpp.dataloaders.XmlDataLoader
- LocalDataBuilder - Interface in fmpp
-
Contains callback to build the local data for a file processing.
- LoggerProgressListener - Class in fmpp.progresslisteners
-
Writes detailed information about errors and warning messages into a file or into any character stream.
- LoggerProgressListener() - Constructor for class fmpp.progresslisteners.LoggerProgressListener
-
Output will be printed to the stderr.
- LoggerProgressListener(File) - Constructor for class fmpp.progresslisteners.LoggerProgressListener
- LoggerProgressListener(File, boolean) - Constructor for class fmpp.progresslisteners.LoggerProgressListener
- LoggerProgressListener(OutputStream) - Constructor for class fmpp.progresslisteners.LoggerProgressListener
- LoggerProgressListener(PrintWriter) - Constructor for class fmpp.progresslisteners.LoggerProgressListener
M
- main(String[]) - Static method in class fmpp.tools.CommandLine
-
Runs the command line interface.
- mapContainsObject(Map<?, ?>, Object) - Static method in class fmpp.util.MiscUtil
-
Checks if the map contains the given object (exactly the same instance) as value.
- MapLocalDataBuilder - Class in fmpp.localdatabuilders
-
Trivial local data builder that returns the
Map
passed to its constructor. - MapLocalDataBuilder(Map) - Constructor for class fmpp.localdatabuilders.MapLocalDataBuilder
- merge(Settings, Object, Object) - Method in class fmpp.setting.Settings.SettingType
-
Merges two setting values.
- MiscUtil - Class in fmpp.util
-
Miscellaneous utility methods.
- MiscUtil() - Constructor for class fmpp.util.MiscUtil
- MSG_ARG_MISSING - Static variable in class fmpp.util.ArgsParser
- MSG_ARG_NOT_ALLOWED - Static variable in class fmpp.util.ArgsParser
- MSG_OPTION_CONFLICT - Static variable in class fmpp.util.ArgsParser
- MSG_OPTION_UNKNOWN - Static variable in class fmpp.util.ArgsParser
- MultiListIterator - Class in fmpp.util
-
Iterates over multiple
List
-s. - MultiListIterator() - Constructor for class fmpp.util.MultiListIterator
- MultiListIterator(List) - Constructor for class fmpp.util.MultiListIterator
- MultiListIterator(List, List) - Constructor for class fmpp.util.MultiListIterator
- MultiListIterator(List, List, List) - Constructor for class fmpp.util.MultiListIterator
- MultiListIterator(List, List, List, List) - Constructor for class fmpp.util.MultiListIterator
N
- NAME_ALWAYS_CREATE_DIRECTORIES - Static variable in class fmpp.setting.Settings
- NAME_APPEND_LOG_FILE - Static variable in class fmpp.setting.Settings
- NAME_BOOLEAN_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_BORDERS - Static variable in class fmpp.setting.Settings
- NAME_CASE_SENSITIVE - Static variable in class fmpp.setting.Settings
- NAME_COLUMNS - Static variable in class fmpp.setting.Settings
- NAME_CONFIGURATION_BASE - Static variable in class fmpp.setting.Settings
- NAME_DATA - Static variable in class fmpp.setting.Settings
- NAME_DATA_ROOT - Static variable in class fmpp.setting.Settings
- NAME_DATE_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_DATETIME_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_ECHO_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_EXPERT - Static variable in class fmpp.setting.Settings
- NAME_FREEMARKER_INCOMPATIBLE_IMPROVEMENTS - Static variable in class fmpp.setting.Settings
- NAME_FREEMARKER_LINKS - Static variable in class fmpp.setting.Settings
- NAME_IGNORE_CVS_FILES - Static variable in class fmpp.setting.Settings
- NAME_IGNORE_SVN_FILES - Static variable in class fmpp.setting.Settings
- NAME_IGNORE_TEMPORARY_FILES - Static variable in class fmpp.setting.Settings
- NAME_INHERIT_CONFIGURATION - Static variable in class fmpp.setting.Settings
- NAME_INTERPOLATION_SYNTAX - Static variable in class fmpp.setting.Settings
- NAME_LOCAL_DATA - Static variable in class fmpp.setting.Settings
- NAME_LOCALE - Static variable in class fmpp.setting.Settings
- NAME_LOG_FILE - Static variable in class fmpp.setting.Settings
- NAME_MAP_COMMON_EXTENSIONS_TO_OUTPUT_FORMATS - Static variable in class fmpp.setting.Settings
- NAME_MODES - Static variable in class fmpp.setting.Settings
- NAME_NUMBER_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_OBJECT_WRAPPER - Static variable in class fmpp.setting.Settings
- NAME_OUTPUT_ENCODING - Static variable in class fmpp.setting.Settings
- NAME_OUTPUT_FILE - Static variable in class fmpp.setting.Settings
- NAME_OUTPUT_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_OUTPUT_FORMATS_BY_PATH - Static variable in class fmpp.setting.Settings
- NAME_OUTPUT_ROOT - Static variable in class fmpp.setting.Settings
- NAME_PRINT_STACK_TRACE - Static variable in class fmpp.setting.Settings
- NAME_QUIET - Static variable in class fmpp.setting.Settings
- NAME_RECOMMENDED_DEFAULTS - Static variable in class fmpp.setting.Settings
- NAME_REMOVE_EXTENSIONS - Static variable in class fmpp.setting.Settings
- NAME_REMOVE_FREEMARKER_EXTENSIONS - Static variable in class fmpp.setting.Settings
- NAME_REMOVE_POSTFIXES - Static variable in class fmpp.setting.Settings
- NAME_REPLACE_EXTENSIONS - Static variable in class fmpp.setting.Settings
- NAME_SKIP_UNCHANGED - Static variable in class fmpp.setting.Settings
- NAME_SNIP - Static variable in class fmpp.setting.Settings
- NAME_SOURCE_ENCODING - Static variable in class fmpp.setting.Settings
- NAME_SOURCE_ROOT - Static variable in class fmpp.setting.Settings
- NAME_SOURCES - Static variable in class fmpp.setting.Settings
- NAME_SQL_DATE_AND_TIME_TIME_ZONE - Static variable in class fmpp.setting.Settings
- NAME_STOP_ON_ERROR - Static variable in class fmpp.setting.Settings
- NAME_TAG_SYNTAX - Static variable in class fmpp.setting.Settings
- NAME_TEMPLATE_DATA - Static variable in class fmpp.setting.Settings
- NAME_TIME_FORMAT - Static variable in class fmpp.setting.Settings
- NAME_TIME_ZONE - Static variable in class fmpp.setting.Settings
- NAME_TURNS - Static variable in class fmpp.setting.Settings
- NAME_URL_ESCAPING_CHARSET - Static variable in class fmpp.setting.Settings
- NAME_VALIDATE_XML - Static variable in class fmpp.setting.Settings
- NAME_XML_CATALOG_FILES - Static variable in class fmpp.setting.Settings
- NAME_XML_CATALOG_PREFER - Static variable in class fmpp.setting.Settings
- NAME_XML_RENDERINGS - Static variable in class fmpp.setting.Settings
- NAME_XPATH_ENGINE - Static variable in class fmpp.setting.Settings
- newMissingParamException(String) - Method in class fmpp.models.TemplateModelUtils
- newNoParamsAllowedException() - Method in class fmpp.models.TemplateModelUtils
- newUnsupportedParamException(String) - Method in class fmpp.models.TemplateModelUtils
- NewWritableHashMethod - Class in fmpp.models
-
Creates a new, empty
WritableHash
. - NewWritableHashMethod() - Constructor for class fmpp.models.NewWritableHashMethod
- NewWritableSequenceMethod - Class in fmpp.models
-
Creates a new, empty
WritableSequence
. - NewWritableSequenceMethod() - Constructor for class fmpp.models.NewWritableSequenceMethod
- next() - Method in class fmpp.util.MultiListIterator
- NODE_TYPE - Static variable in class fmpp.models.JSONArrayNode
- NODE_TYPE - Static variable in class fmpp.models.JSONBooleanNode
- NODE_TYPE - Static variable in class fmpp.models.JSONNullNode
- NODE_TYPE - Static variable in class fmpp.models.JSONNumberNode
- NODE_TYPE - Static variable in class fmpp.models.JSONObjectNode
- NODE_TYPE - Static variable in class fmpp.models.JSONStringNode
- nodeTypeToDefaultNodeName(String) - Static method in class fmpp.models.JSONNode
-
Returns the FTL node name for a node that has otherwise no name.
- normalizeLinebreaks(String) - Static method in class fmpp.util.StringUtil
-
Converts all line-breaks to UN*X linebreaks (
"\n"
). - notify(int, Interpreter, String, Object) - Method in class fmpp.tdd.DataLoaderEvaluationEnvironment
- notify(int, Interpreter, String, Object) - Method in interface fmpp.tdd.EvaluationEnvironment
-
Notifies about an event during expression evaluation.
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.localdatabuilders.CachingLocalDataBuilder
-
Discards the cached result on
ProgressListener.EVENT_END_PROCESSING_SESSION
. - notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in interface fmpp.ProgressListener
-
Method called be the engine to notify events.
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.progresslisteners.AntProgressListener
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.progresslisteners.ConsoleProgressListener
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.progresslisteners.LoggerProgressListener
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.progresslisteners.StatisticsProgressListener
- notifyProgressEvent(Engine, int, File, int, Throwable, Object) - Method in class fmpp.progresslisteners.TerseConsoleProgressListener
- NowDataLoader - Class in fmpp.dataloaders
-
Data loader that produces string from the current date.
- NowDataLoader() - Constructor for class fmpp.dataloaders.NowDataLoader
- NullOutputStream - Class in fmpp.util
-
OutputStream
that simply drops what it gets. - NullWriter - Class in fmpp.util
-
Writer
that simply drops what it gets. - numberToInt(Number) - Static method in class fmpp.util.MiscUtil
-
Loseless convertion to
int
.
O
- OLD_NAME_REMOVE_EXTENSION - Static variable in class fmpp.setting.Settings
- OLD_NAME_REMOVE_POSTFIX - Static variable in class fmpp.setting.Settings
- OLD_NAME_REPLACE_EXTENSION - Static variable in class fmpp.setting.Settings
- OPTION_INDEX - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_NAME_ENCODING - Static variable in class fmpp.util.DataLoaderUtil
- OPTION_NAMESPACE_AWARE - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_REMOVE_COMMENTS - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_REMOVE_PIS - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_VALIDATE - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_XINCLUDE_AWARE - Static variable in class fmpp.dataloaders.XmlDataLoader
- OPTION_XMLNS - Static variable in class fmpp.dataloaders.XmlDataLoader
- OptionDefinition() - Constructor for class fmpp.util.ArgsParser.OptionDefinition
P
- PARAMETER_VALUE_HOST - Static variable in class fmpp.Engine
-
A commonly used reserved parameter value:
"host"
. - PARAMETER_VALUE_OUTPUT - Static variable in class fmpp.Engine
-
A commonly used reserved parameter value:
"source"
. - PARAMETER_VALUE_SOURCE - Static variable in class fmpp.Engine
-
A commonly used reserved parameter value:
"source"
. - parse(Settings, String, boolean) - Method in class fmpp.setting.Settings.SettingType
-
Converts a string value to the type of the setting.
- parse(String[]) - Method in class fmpp.util.ArgsParser
-
Parses the args[].
- parse(String, String) - Static method in class fmpp.util.JSONParser
- ParseException(String) - Constructor for exception fmpp.util.StringUtil.ParseException
- ParseException(String, int) - Constructor for exception fmpp.util.StringUtil.ParseException
- ParseException(String, int, Throwable) - Constructor for exception fmpp.util.StringUtil.ParseException
- ParseException(String, String, int, String) - Constructor for exception fmpp.util.StringUtil.ParseException
- ParseException(String, String, int, String, Throwable) - Constructor for exception fmpp.util.StringUtil.ParseException
- ParseException(String, Throwable) - Constructor for exception fmpp.util.StringUtil.ParseException
- parseExtraArguments(List) - Method in class fmpp.dataloaders.AbstractTextDataLoader
-
Parses the argument list, except the 1st (file name) argument.
- parseExtraArguments(List) - Method in class fmpp.dataloaders.SlicedTextDataLoader
- parseText(String) - Method in class fmpp.dataloaders.AbstractTextDataLoader
-
Parses the file content to the final object that the data loader will return.
- parseText(String) - Method in class fmpp.dataloaders.SlicedTextDataLoader
- pathPatternToPerl5Regex(String) - Static method in class fmpp.util.FileUtil
-
Converts UN*X style path to regular expression (originally, for Perl 5 dialect, but also works for Java's dialect).
- pathToUnixStyle(String) - Static method in class fmpp.util.FileUtil
-
Brings the path to UNI*X style format, so that it can be handled with path pattern handling functions.
- PMODE_COPY - Static variable in class fmpp.Engine
-
Processing mode: Copy the file as-is (binary copy).
- PMODE_EXECUTE - Static variable in class fmpp.Engine
-
Processing mode: Execute the file as template
- PMODE_IGNORE - Static variable in class fmpp.Engine
-
Processing mode: Ignore the file.
- PMODE_NONE - Static variable in class fmpp.Engine
-
Processing mode: N/A
- PMODE_RENDER_XML - Static variable in class fmpp.Engine
-
Processing mode: Render XML with an FTL template.
- postProcessItems(List) - Method in class fmpp.dataloaders.SlicedTextDataLoader
-
Override this if you want to post-process the items.
- println() - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints line-break into the log.
- println(Object) - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints into the log with word-wrapping.
- println(String) - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints into the log with word-wrapping.
- println(String, int) - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints into the log with word-wrapping and indentation.
- printlnNW(String) - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints into the log without word-wrapping.
- printNW(String) - Method in class fmpp.progresslisteners.LoggerProgressListener
-
Prints into the log without word-wrapping.
- printStackTrace() - Method in exception fmpp.util.RuntimeExceptionCC
- printStackTrace(PrintStream) - Method in exception fmpp.util.RuntimeExceptionCC
- printStackTrace(PrintWriter) - Method in exception fmpp.util.RuntimeExceptionCC
- printStackTrace(Throwable) - Method in class fmpp.progresslisteners.LoggerProgressListener
- process(File[]) - Method in class fmpp.Engine
-
Processes a list of files.
- process(File, File) - Method in class fmpp.Engine
-
Hack to processes a single file.
- ProcessingException - Exception in fmpp
-
Error while performing the processing session.
- ProcessingException(Engine, File, Throwable) - Constructor for exception fmpp.ProcessingException
- ProgressListener - Interface in fmpp
-
Interface to monitor the events of an
Engine
. - PropertiesDataLoader - Class in fmpp.dataloaders
-
Returns a Map based on a Java properties file.
- PropertiesDataLoader() - Constructor for class fmpp.dataloaders.PropertiesDataLoader
- property(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
-
Sets the property name for this option.
- property(String, String) - Method in class fmpp.util.ArgsParser.OptionDefinition
-
Convenience method; same as calling
property(String)
and thenpropertyValue
. - propertyValue(String) - Method in class fmpp.util.ArgsParser.OptionDefinition
-
Sets the property value for this option.
Q
- quietSettingValueToInt(String, String) - Static method in class fmpp.setting.Settings
-
Returns 0 for verbose mode, 1 for quiet mode, 2 for really-quiet mode.
R
- read() - Method in class fmpp.util.BorderedReader
- read(char[], int, int) - Method in class fmpp.util.BorderedReader
- remove() - Method in class fmpp.util.MultiListIterator
- remove(String) - Method in class fmpp.setting.Settings
-
Removes a setting value; after this
Settings.get(String)
will returnnull
. - removeAttribute(String) - Method in class fmpp.Engine
-
Removes an attribute.
- removeAttribute(String) - Method in class fmpp.setting.Settings
-
Removes an engine attribute.
- removeData(String) - Method in class fmpp.Engine
-
Removes a variable that would be visible for all templates when the processing session executes.
- removeSlashPrefix(String) - Static method in class fmpp.util.FileUtil
- RemoveTransform - Class in fmpp.models
-
Removes an item from a
WritableSequence
orWritableHash
. - RemoveTransform() - Constructor for class fmpp.models.RemoveTransform
- renameOutputFile(String) - Method in class fmpp.TemplateEnvironment
-
It does the same as the directive in the pp hash.
- repeat(String, int) - Static method in class fmpp.util.StringUtil
- replace(String, String, String) - Static method in class fmpp.util.StringUtil
-
Replaces all occurances of a sub-string in a string.
- reset() - Method in class fmpp.progresslisteners.StatisticsProgressListener
-
Rests all counters.
- resolveOutputPath(String) - Method in class fmpp.TemplateEnvironment
-
Resolves a output path to a File object.
- resolveRelativeUnixPath(File, File, String) - Static method in class fmpp.util.FileUtil
-
Resolves relative UN*X path based on given root and working directory.
- resolveSourcePath(String) - Method in class fmpp.TemplateEnvironment
-
Resolves a source path to a File object.
- restartOutputFile() - Method in class fmpp.TemplateEnvironment
-
It does the same as the directive in the pp hash.
- RETURN_FRAGMENT - Static variable in interface fmpp.tdd.EvaluationEnvironment
- RETURN_SKIP - Static variable in interface fmpp.tdd.EvaluationEnvironment
- rtfEnc(String) - Static method in class fmpp.util.StringUtil
-
Rich Text Format encoding (does not replace line breaks).
- RuntimeExceptionCC - Exception in fmpp.util
-
RuntimeException
that emulates J2SE 1.4+ cause-chains if it runs on earlier versions. - RuntimeExceptionCC() - Constructor for exception fmpp.util.RuntimeExceptionCC
- RuntimeExceptionCC(String) - Constructor for exception fmpp.util.RuntimeExceptionCC
- RuntimeExceptionCC(String, Throwable) - Constructor for exception fmpp.util.RuntimeExceptionCC
- RuntimeExceptionCC(Throwable) - Constructor for exception fmpp.util.RuntimeExceptionCC
S
- set(String, boolean) - Method in class fmpp.setting.Settings
-
Convenience method for setting a
Boolean
value. - set(String, int) - Method in class fmpp.setting.Settings
-
Convenience method for setting an
Integer
value. - set(String, Object) - Method in class fmpp.setting.Settings
-
Sets the value of a setting.
- set(Map) - Method in class fmpp.setting.Settings
-
Calls
Settings.set(String, Object)
for each name-value pair of theMap
. - setAltFalse(String) - Method in class fmpp.models.CsvSequence
-
Alternative word used to indicate boolean false in the CSV file.
- setAltTrue(String) - Method in class fmpp.models.CsvSequence
-
Alternative word used to indicate boolean true in the CSV file.
- setAlwaysCreateDirectories(boolean) - Method in class fmpp.Engine
-
Sets whether for source directories a corresponding output directory will be created even if no file output went into it.
- setAlwaysCreateDirectories(boolean) - Method in class fmpp.tools.AntTask
- setAlwaysCreateDirs(boolean) - Method in class fmpp.tools.AntTask
-
Same as
AntTask.setAlwaysCreateDirectories(boolean)
; added as this name is closer to the Ant naming conventions. - setAntTaskFailOnError(boolean) - Method in class fmpp.tools.AntTask
- setAppendLogFile(boolean) - Method in class fmpp.tools.AntTask
- setAttribute(String, Object) - Method in class fmpp.Engine
-
Adds/replaces an engine attribute.
- setBooleanFormat(String) - Method in class fmpp.Engine
-
Sets the boolean format used to convert boolean to strings, as defined by
Configurable.setBooleanFormat(String)
. - setBooleanFormat(String) - Method in class fmpp.tools.AntTask
- setBorders(String) - Method in class fmpp.tools.AntTask
- setCaseSensitive(boolean) - Method in class fmpp.Engine
-
Sets if the engine differentiates upper- and lower-case letters when it compares paths or matches path patterns with paths.
- setCaseSensitive(boolean) - Method in class fmpp.tools.AntTask
- setConfiguration(File) - Method in class fmpp.tools.AntTask
- setConfigurationBase(File) - Method in class fmpp.tools.AntTask
- setCopy(boolean) - Method in class fmpp.XmlRenderingConfiguration
-
Sets if the XML file should be copied as is, or renderd with a template.
- setData(String) - Method in class fmpp.tools.AntTask
- setDataRoot(File) - Method in class fmpp.Engine
-
Sets the root directory of data files.
- setDataRoot(File) - Method in class fmpp.tools.AntTask
- setDateFormat(String) - Method in class fmpp.Engine
-
Sets the format used to convert date values (year + month + day) to strings.
- setDateFormat(String) - Method in class fmpp.tools.AntTask
- setDateFormatPattern(String) - Method in class fmpp.models.CsvSequence
-
Sets the pattern used to parse date columns.
- setDateTimeFormat(String) - Method in class fmpp.Engine
-
Sets the format used to convert date-time values (year + month + day + hour + minute + second + millisecond) to strings.
- setDateTimeFormat(String) - Method in class fmpp.tools.AntTask
- setDateTimeFormatPattern(String) - Method in class fmpp.models.CsvSequence
-
Sets the pattern used to parse date-time columns.
- setDecimalSeparator(char) - Method in class fmpp.models.CsvSequence
-
Sets the alternative symbol used for the decimal dot in the file for numbers.
- setDefault(String, boolean) - Method in class fmpp.setting.Settings
-
Convenience method for setting a
Boolean
value; seeSettings.setDefault(String, Object)
. - setDefault(String, int) - Method in class fmpp.setting.Settings
-
Convenience method for setting an
Integer
value; seeSettings.setDefault(String, Object)
. - setDefault(String, Object) - Method in class fmpp.setting.Settings
-
Sets the value of a setting if the value wasn't set yet.
- setDefaultProperties(Properties) - Method in class fmpp.util.ArgsParser
-
Sets the properies object that will be the default properties object for the properies object that
parse
creates for the options (SeeProperties(Properties defaults)
). - setDefaults(Map) - Method in class fmpp.setting.Settings
-
Similar to
Settings.set(Map)
, but callsSettings.setDefault(String, Object)
instead ofSettings.set(String, Object)
. - setDefaultsWithStrings(Properties) - Method in class fmpp.setting.Settings
-
Similar to
Settings.setWithStrings(Properties)
, but callsSettings.setDefaultWithString(String, String)
instead ofSettings.setWithString(String, String)
. - setDefaultWithString(String, String) - Method in class fmpp.setting.Settings
-
Same as
Settings.setDefault(String, Object)
, but uses a string value that will be parsed withSettings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean)
. - setDestDir(File) - Method in class fmpp.tools.AntTask
- setDir(File) - Method in class fmpp.tools.AntTask
- setDontTraverseDirectories(boolean) - Method in class fmpp.Engine
- setDontTraverseDirectories(boolean) - Method in class fmpp.setting.Settings
- setEmptyValues(String[]) - Method in class fmpp.models.CsvSequence
-
Specifies the list of cell values that will be replaced with an empty (0 length) string.
- setEncoding(String) - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
-
Sets the encoding of the script files.
- setEnding(String) - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
-
Sets the string appended at the end of the source file name.
- setEngineAttribute(String, Object) - Method in class fmpp.setting.Settings
-
Sets an engine attribute.
- setExpandProperties(boolean) - Method in class fmpp.tools.AntTask.AntAttributeSubstitution
- setExpert(boolean) - Method in class fmpp.tools.AntTask
- setExpertMode(boolean) - Method in class fmpp.Engine
-
Allows some features that are considered dangerous.
- setExternalHeaderRow(String[]) - Method in class fmpp.models.CsvSequence
-
If it is not
null
, then it is used as the header row instead of the first row of the CSV file. - setFreemarkerIncompatibleImprovements(String) - Method in class fmpp.tools.AntTask
- setFreemarkerLinks(String) - Method in class fmpp.tools.AntTask
- setGroupingSeparator(char) - Method in class fmpp.models.CsvSequence
-
Set the grouping separator symbol used for grouping in the file for numbers.
- setHasHeaderRow(boolean) - Method in class fmpp.models.CsvSequence
-
Specifies if the file contains header row or not.
- setIgnoreCvsFiles(boolean) - Method in class fmpp.Engine
-
Sets if the CVS files inside the source root directory should be ignored or not.
- setIgnoreMissing(boolean) - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
- setIgnoreSvnFiles(boolean) - Method in class fmpp.Engine
-
Sets if the SVN files inside the source root directory should be ignored or not.
- setIgnoreTemporaryFiles(boolean) - Method in class fmpp.Engine
-
Set if well-known temporary files inside the source root directory should be ignored or not.
- setInheritConfiguration(File) - Method in class fmpp.tools.AntTask
- setInterpolationSyntax(int) - Method in class fmpp.Engine
-
Sets the
interpolationSyntax
setting of FreeMarker. - setInterpolationSyntax(String) - Method in class fmpp.tools.AntTask
- setList(List) - Method in class fmpp.models.WritableSequence
- setLocalData(String) - Method in class fmpp.tools.AntTask
- setLocale(String) - Method in class fmpp.Engine
-
Sets the locale (country, language).
- setLocale(String) - Method in class fmpp.tools.AntTask
- setLocale(Locale) - Method in class fmpp.Engine
-
Sets the locale (country, language).
- setLogFile(File) - Method in class fmpp.tools.AntTask
- setMap(Map) - Method in class fmpp.models.WritableHash
- setMapCommonExtensionsToOutputFormats(boolean) - Method in class fmpp.Engine
-
Sets if some very commonly used file extensions (see below) should be automatically associated with a FreeMarker
OutputFormat
, for the purpose of auto-escaping. - setMapCommonExtensionsToOutputFormats(String) - Method in class fmpp.tools.AntTask
- setMessages(Properties) - Method in class fmpp.util.ArgsParser
-
Customizes the error messages shown to the user.
- setModes(String) - Method in class fmpp.tools.AntTask
- setNormalizeHeaders(boolean) - Method in class fmpp.models.CsvSequence
-
Specifies if the header names coming from the file will be normalized or should be left as is.
- setNumberFormat(String) - Method in class fmpp.Engine
-
Sets the number format used to convert numbers to strings, as defined by
Configurable.setNumberFormat(String)
. - setNumberFormat(String) - Method in class fmpp.tools.AntTask
- setObjectWrapper(String) - Method in class fmpp.tools.AntTask
- setOldTemplateSyntax(boolean) - Method in class fmpp.Engine
-
Sets if the
#
is required in FTL tags or not. - setOutputEncoding(String) - Method in class fmpp.Engine
-
Sets the encoding used for textural output (template generated files).
- setOutputEncoding(String) - Method in class fmpp.TemplateEnvironment
-
It does the same as the directive in the pp hash.
- setOutputEncoding(String) - Method in class fmpp.tools.AntTask
- setOutputFile(File) - Method in class fmpp.tools.AntTask
- setOutputFormat(OutputFormat) - Method in class fmpp.Engine
-
Sets the
OutputFormat
used in templates when there's no more specific one chosen by path pattern. - setOutputFormat(String) - Method in class fmpp.tools.AntTask
- setOutputFormatsByPath(String) - Method in class fmpp.tools.AntTask
- setOutputRoot(File) - Method in class fmpp.Engine
-
Sets the root directory of output files.
- setOutputRoot(File) - Method in class fmpp.tools.AntTask
- setOutputRoot_common(File, boolean) - Method in class fmpp.tools.AntTask
- setQuiet(String) - Method in class fmpp.tools.AntTask
- setRecommendedDefaults(String) - Method in class fmpp.tools.AntTask
- setRemoveExtension(boolean) - Method in class fmpp.localdatabuilders.BshLocalDataBuilder
-
Sets if the extension from the source file name should be removed before appending the
ending
. - setRemoveExtension(String) - Method in class fmpp.tools.AntTask
- setRemoveExtensions(String) - Method in class fmpp.tools.AntTask
- setRemoveFreemarkerExtensions(boolean) - Method in class fmpp.Engine
-
Sets if the standard FreeMarker file extensions (
ftl
,ftlh
,ftlx
) should be removed from the output file name. - setRemoveFreemarkerExtensions(String) - Method in class fmpp.tools.AntTask
- setRemovePostfix(String) - Method in class fmpp.tools.AntTask
- setRemovePostfixes(String) - Method in class fmpp.tools.AntTask
- setReplaceExtension(String) - Method in class fmpp.tools.AntTask
- setReplaceExtensions(String) - Method in class fmpp.tools.AntTask
- setSeparator(char) - Method in class fmpp.models.CsvSequence
-
Separator char between cloumns.
- setSkipUnchanged(int) - Method in class fmpp.Engine
-
Sets what source file can be skipped if it was not modified after the last modification time of the output file.
- setSkipUnchanged(String) - Method in class fmpp.tools.AntTask
- setSourceEncoding(String) - Method in class fmpp.Engine
-
Sets the encoding (charset) of textual source files.
- setSourceEncoding(String) - Method in class fmpp.tools.AntTask
- setSourceFile(File) - Method in class fmpp.tools.AntTask
- setSourceRoot(File) - Method in class fmpp.Engine
-
Sets the root directory of source files.
- setSourceRoot(File) - Method in class fmpp.tools.AntTask
- setSourceRoot_common(File, boolean) - Method in class fmpp.tools.AntTask
- setSQLDateAndTimeTimeZone(String) - Method in class fmpp.Engine
-
Same as
Engine.setSQLDateAndTimeTimeZone(TimeZone)
, but lets FreeMarker parse the value to time zone. - setSQLDateAndTimeTimeZone(String) - Method in class fmpp.tools.AntTask
- setSQLDateAndTimeTimeZone(TimeZone) - Method in class fmpp.Engine
-
Sets the time zone used when dealing with
java.sql.Date
andjava.sql.Time
values. - setSrcDir(File) - Method in class fmpp.tools.AntTask
- setStopOnError(boolean) - Method in class fmpp.Engine
- setStopOnError(boolean) - Method in class fmpp.tools.AntTask
- setTagSyntax(int) - Method in class fmpp.Engine
-
Sets the
tagSyntax
setting of FreeMarker. - setTagSyntax(String) - Method in class fmpp.tools.AntTask
- setTemplate(String) - Method in class fmpp.XmlRenderingConfiguration
-
Sets the renderer template.
- setTemplateData(String) - Method in class fmpp.tools.AntTask
- setTemplateDataModelBuilder(TemplateDataModelBuilder) - Method in class fmpp.Engine
-
Deprecated.
- setTemplateDataModelBuilder(String) - Method in class fmpp.Engine
-
Deprecated.
- setTimeFormat(String) - Method in class fmpp.Engine
-
Sets the format used to convert time values (hour + minute + second + millisecond) to strings.
- setTimeFormat(String) - Method in class fmpp.tools.AntTask
- setTimeFormatPattern(String) - Method in class fmpp.models.CsvSequence
-
Sets the pattern used to parse time columns.
- setTimeZone(String) - Method in class fmpp.Engine
-
Same as
Engine.setTimeZone(TimeZone)
, but lets FreeMarker parse the value to time zone. - setTimeZone(String) - Method in class fmpp.tools.AntTask
- setTimeZone(TimeZone) - Method in class fmpp.Engine
-
Sets the time zone used to display date/time/date-time values.
- setTimeZone(TimeZone) - Method in class fmpp.models.CsvSequence
-
Sets the time zone used for parsing date/time/date-time that does not specify a time zone explicitly.
- SettingException - Exception in fmpp.setting
-
Bad setting or setting combination, or failure when trying to setup the engine with the settings.
- SettingException(String) - Constructor for exception fmpp.setting.SettingException
- SettingException(String, Throwable) - Constructor for exception fmpp.setting.SettingException
- Settings - Class in fmpp.setting
-
Stores FMPP settings, loads configuration files, provides other setting handling related utilities.
- Settings(File) - Constructor for class fmpp.setting.Settings
-
Creates a new instance.
- Settings.SettingType - Class in fmpp.setting
-
Represents the type of the value of a setting.
- SetTransform - Class in fmpp.models
-
Changes items an item in a
WritableSequence
or sets/adds and item to aWritableHash
. - SetTransform() - Constructor for class fmpp.models.SetTransform
- setTrimCells(boolean) - Method in class fmpp.models.CsvSequence
-
Specifies if all cells will be trimmed.
- setTurns(String) - Method in class fmpp.tools.AntTask
- setUrlEscapingCharset(String) - Method in class fmpp.Engine
-
Sets the charset used for URL escaping.
- setUrlEscapingCharset(String) - Method in class fmpp.tools.AntTask
- setValidateXml(boolean) - Method in class fmpp.Engine
-
Sets if XML documents should be validated when they are loaded.
- setValidateXml(String) - Method in class fmpp.tools.AntTask
- setWithString(String, String) - Method in class fmpp.setting.Settings
-
Same as
Settings.set(String, Object)
, but uses string value that will be parsed withSettings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean)
. - setWithStrings(Properties) - Method in class fmpp.setting.Settings
-
Calls
Settings.setWithString(String, String)
for each name-value pair of theProperties
. - setXHtml(boolean) - Method in class fmpp.dataloaders.HtmlUtilsDataLoader
- setXmlCatalogFiles(String) - Method in class fmpp.tools.AntTask
- setXmlCatalogPrefer(String) - Method in class fmpp.tools.AntTask
- setXmlEntityResolver(Object) - Method in class fmpp.Engine
-
Sets the XML entiry resolver used for reading XML documents.
- setXmlRenderings(String) - Method in class fmpp.tools.AntTask
- setXpathEngine(String) - Method in class fmpp.Engine
-
Sets if which XPath engine should be used.
- setXpathEngine(String) - Method in class fmpp.tools.AntTask
- SIMPLE_EVALUATION_ENVIRONMENT - Static variable in class fmpp.tdd.Interpreter
-
Evaluates function calls to itself.
- size() - Method in class fmpp.models.CsvSequence
- size() - Method in class fmpp.models.JSONArrayNode
- size() - Method in class fmpp.models.JSONObjectNode
- size() - Method in class fmpp.models.StringArraySequence
- size() - Method in class fmpp.models.TemplateModelListSequence
- size() - Method in class fmpp.models.WritableHash
- size() - Method in class fmpp.models.WritableSequence
- skip(long) - Method in class fmpp.util.BorderedReader
- SKIP_ALL - Static variable in class fmpp.Engine
-
Used with the "skipUnchanged" engine parameter: skip all unchanged files
- SKIP_NONE - Static variable in class fmpp.Engine
-
Used with the "skipUnchnaged" engine parameter: never skip files
- SKIP_STATIC - Static variable in class fmpp.Engine
-
Used with the "skipUnchanged" engine parameter: skip unchanged static files
- SlicedTextDataLoader - Class in fmpp.dataloaders
-
Returns a sequence of strings based on a plain text file, where the specified symbol is used as separator.
- SlicedTextDataLoader() - Constructor for class fmpp.dataloaders.SlicedTextDataLoader
- split(String, char) - Static method in class fmpp.util.StringUtil
-
Same as
split(s, c, false)
. - split(String, char, boolean) - Static method in class fmpp.util.StringUtil
-
Splits a string at the specified character, and optionally trims the items.
- split(String, String) - Static method in class fmpp.util.StringUtil
-
Splits a string at the specified string.
- splitAtWS(String) - Static method in class fmpp.util.StringUtil
-
Splits a string at white-spaces.
- StatisticsProgressListener - Class in fmpp.progresslisteners
-
Spins some counters regarding the work of the Engine.
- StatisticsProgressListener() - Constructor for class fmpp.progresslisteners.StatisticsProgressListener
- StringArraySequence - Class in fmpp.models
-
Sequence variable implementation that wraps a String[] with relatively low resource utilization.
- StringArraySequence(String[]) - Constructor for class fmpp.models.StringArraySequence
-
Warning: Does not copy the argument array!
- stringToBigDecimal(String) - Static method in class fmpp.util.StringUtil
-
Converts a string to
BigDecimal
. - stringToBoolean(String) - Static method in class fmpp.util.StringUtil
- stringToDate(String, TimeZone) - Static method in class fmpp.util.StringUtil
-
Parses a date of format
"yyyy-MM-dd"
or"yyyy-MM-dd z"
and returns it asTemplateDateModel
. - stringToDateTime(String, TimeZone) - Static method in class fmpp.util.StringUtil
-
Parses a date-time of format
"yyyy-MM-dd H:mm:ss"
or"yyyy-MM-dd h:mm:ss a"
or"yyyy-MM-dd H:mm:ss z"
or"yyyy-MM-dd h:mm:ss a z"
and returns it asTemplateDateModel
. - stringToPerl5Regex(String) - Static method in class fmpp.util.StringUtil
-
Convers string to Perl 5 regular expression.
- stringToTime(String, TimeZone) - Static method in class fmpp.util.StringUtil
-
Parses a time of format
"H:mm:ss"
or"h:mm:ss a"
or"H:mm:ss z"
or"h:mm:ss a z"
and returns it asTemplateDateModel
. - StringUtil - Class in fmpp.util
-
Collection of string manipulation functions.
- StringUtil() - Constructor for class fmpp.util.StringUtil
- StringUtil.ParseException - Exception in fmpp.util
-
Formal (syntactical) problem with the text.
- strParam(Object, String) - Method in class fmpp.models.TemplateModelUtils
T
- TddDataLoader - Class in fmpp.dataloaders
-
Creates a Map based on a TDD file.
- TddDataLoader() - Constructor for class fmpp.dataloaders.TddDataLoader
- TddHashLocalDataBuilder - Class in fmpp.localdatabuilders
-
Builds data from a TDD hash, interpreting function calls as data loader invocations.
- TddHashLocalDataBuilder(Fragment) - Constructor for class fmpp.localdatabuilders.TddHashLocalDataBuilder
- TddHashLocalDataBuilder(String) - Constructor for class fmpp.localdatabuilders.TddHashLocalDataBuilder
- TddSequenceDataLoader - Class in fmpp.dataloaders
-
Creates a List based on a TDD file.
- TddSequenceDataLoader() - Constructor for class fmpp.dataloaders.TddSequenceDataLoader
- TddUtil - Class in fmpp.tdd
-
Utility methods for TDD related tasks.
- TddUtil() - Constructor for class fmpp.tdd.TddUtil
- TemplateDataModelBuilder - Interface in fmpp
-
Deprecated.Use
LocalDataBuilder
instead. - TemplateEnvironment - Class in fmpp
-
The runtime FMPP environment of an executing template.
- TemplateModelArrayCollection - Class in fmpp.models
-
Collection variable implementation that wraps an array of already wrapped objects directly.
- TemplateModelArrayCollection(TemplateModel[]) - Constructor for class fmpp.models.TemplateModelArrayCollection
- TemplateModelListCollection - Class in fmpp.models
-
Collection variable implementation that wraps a java.util.List of already wrapped objects directly.
- TemplateModelListCollection(List) - Constructor for class fmpp.models.TemplateModelListCollection
- TemplateModelListSequence - Class in fmpp.models
-
Sequence that wraps a
java.util.List
of already wrapped objects directly, with minimal resource usage. - TemplateModelListSequence(List) - Constructor for class fmpp.models.TemplateModelListSequence
- TemplateModelUtils - Class in fmpp.models
-
Constains utility methods for transform and method variable implementation.
- TemplateModelUtils() - Constructor for class fmpp.models.TemplateModelUtils
- TerseConsoleProgressListener - Class in fmpp.progresslisteners
-
Designed to show the progress on console screen in a very terse way (prints a symbol for each processed file).
- TerseConsoleProgressListener() - Constructor for class fmpp.progresslisteners.TerseConsoleProgressListener
-
Output will be printed to the stdout.
- TerseConsoleProgressListener(OutputStream) - Constructor for class fmpp.progresslisteners.TerseConsoleProgressListener
- TerseConsoleProgressListener(PrintWriter) - Constructor for class fmpp.progresslisteners.TerseConsoleProgressListener
- TextDataLoader - Class in fmpp.dataloaders
-
Returns a string based on a plain text file.
- TextDataLoader() - Constructor for class fmpp.dataloaders.TextDataLoader
- toOutputRelatitvePath(String) - Method in class fmpp.TemplateEnvironment
-
Same as
TemplateEnvironment.toSourceRootRelativePath(String)
but with the output file and output root directory. - toOutputRootRelativePath(File) - Method in class fmpp.TemplateEnvironment
-
Convets a file object to an output root relative UN*X style path.
- toSourceRootRelativePath(File) - Method in class fmpp.TemplateEnvironment
-
Converts a file object to a source root relative UN*X style path.
- toSourceRootRelativePath(String) - Method in class fmpp.TemplateEnvironment
-
Returns the path relative to the source root.
- toString() - Method in class fmpp.localdatabuilders.TddHashLocalDataBuilder
- toString() - Method in class fmpp.setting.FileWithConfigurationBase
- toString() - Method in class fmpp.setting.FileWithSettingValue
- toString() - Method in class fmpp.tdd.Fragment
-
Returns the fragment text.
- toString() - Method in class fmpp.tdd.FunctionCall
- toString() - Method in class fmpp.XmlRenderingConfiguration
- trimValues(Properties) - Method in class fmpp.setting.Settings
-
Trims all property values.
- TYPE_ANY - Static variable in class fmpp.setting.Settings
-
Any object.
- TYPE_BOOLEAN - Static variable in class fmpp.setting.Settings
-
Boolean setting type.
- TYPE_CFG_RELATIVE_PATH - Static variable in class fmpp.setting.Settings
-
"Configuration relative path" setting type.
- TYPE_CFG_RELATIVE_PATHS - Static variable in class fmpp.setting.Settings
-
"Configuration relative paths" setting type.
- TYPE_DATA_MODEL - Static variable in class fmpp.setting.Settings
-
Data model setting type.
- TYPE_HASH - Static variable in class fmpp.setting.Settings
-
Hash setting type.
- TYPE_HASH_OF_SEQUENCE_OF_CFG_RELATIVE_PATHS - Static variable in class fmpp.setting.Settings
-
Hash-of-configuration-relative-paths setting type.
- TYPE_INTEGER - Static variable in class fmpp.setting.Settings
-
Integer setting type.
- TYPE_LOCAL_DATA_MODEL - Static variable in class fmpp.setting.Settings
-
Local data model setting type.
- TYPE_SEQUENCE - Static variable in class fmpp.setting.Settings
-
Sequence setting type.
- TYPE_STRING - Static variable in class fmpp.setting.Settings
-
String setting type.
- TYPE_UNRESOLVED_CFG_RELATIVE_PATHS - Static variable in class fmpp.setting.Settings
-
"Unresolved configuration relative paths" setting type.
- TypeNotConvertableToMapException - Exception in fmpp.tdd
-
Thrown by
TddUtil.convertToDataMap(Object)
; see there. - TypeNotConvertableToMapException(String) - Constructor for exception fmpp.tdd.TypeNotConvertableToMapException
- TypeNotConvertableToMapException(String, Throwable) - Constructor for exception fmpp.tdd.TypeNotConvertableToMapException
- TypeNotConvertableToMapException(Throwable) - Constructor for exception fmpp.tdd.TypeNotConvertableToMapException
U
- undashNames(Properties) - Method in class fmpp.setting.Settings
-
Converts legacy dashed setting names to the standard format, as
source-root
tosourceRoot
. - urlEnc(String, String) - Static method in class fmpp.util.StringUtil
-
URL encoding (like%20this).
- urlPathEnc(String, String) - Static method in class fmpp.util.StringUtil
-
URL encoding without escaping slashes.
V
- validateRecommendedDefaults(Version) - Static method in class fmpp.Engine
-
Check if the
recommendedDefaults
is in the supported range. - VALUE_GLOBAL_DEFAULT - Static variable in class fmpp.setting.Settings
- VALUE_HOST - Static variable in class fmpp.setting.Settings
- VALUE_INTERPOLATION_SYNTAX_DOLLAR - Static variable in class fmpp.setting.Settings
- VALUE_INTERPOLATION_SYNTAX_LEGACY - Static variable in class fmpp.setting.Settings
- VALUE_INTERPOLATION_SYNTAX_SQUARE_BRACKET - Static variable in class fmpp.setting.Settings
- VALUE_NONE - Static variable in class fmpp.setting.Settings
- VALUE_OBJECTWRAPPER_SHARED_BEANS_WRAPPER - Static variable in class fmpp.setting.Settings
- VALUE_OUTPUT - Static variable in class fmpp.setting.Settings
- VALUE_REALLY_QUIET - Static variable in class fmpp.setting.Settings
- VALUE_SOURCE - Static variable in class fmpp.setting.Settings
- VALUE_TAG_SYNTAX_ANGLE_BRACKET - Static variable in class fmpp.setting.Settings
- VALUE_TAG_SYNTAX_AUTO_DETECT - Static variable in class fmpp.setting.Settings
- VALUE_TAG_SYNTAX_SQUARE_BRACKET - Static variable in class fmpp.setting.Settings
- VALUE_XML_CATALOG_PREFER_PUBLIC - Static variable in class fmpp.setting.Settings
- VALUE_XML_CATALOG_PREFER_SYSTEM - Static variable in class fmpp.setting.Settings
- values() - Method in class fmpp.models.JSONObjectNode
-
Returns the values from the key-value pairs of this JSON object, returning Java
null
for JSONnull
-s. - values() - Method in class fmpp.models.WritableHash
- VERSION_0_9_15 - Static variable in class fmpp.Engine
- VERSION_0_9_16 - Static variable in class fmpp.Engine
W
- warning(String) - Method in class fmpp.TemplateEnvironment
-
It does the same as the directive in the pp hash.
- wrap(Object) - Method in class fmpp.Engine
-
Wraps any object as
TemplateModel
. - wrap(Object) - Static method in class fmpp.models.JSONNode
- wrap(Object, JSONNode, String, boolean) - Static method in class fmpp.models.JSONNode
- wrap(StringBuffer, int, int, int) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(StringBuffer, int, int, int, String, boolean) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, int) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, int, int) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, int, int, String) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, int, int, String, boolean) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, int, String) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrap(String, int, String) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- wrapTrace(String, int) - Static method in class fmpp.util.StringUtil
-
Hard-wraps flow-text.
- WritableHash - Class in fmpp.models
-
Hash variable that can be changed during template execution with the proper method variables.
- WritableHash() - Constructor for class fmpp.models.WritableHash
- WritableHash(Map) - Constructor for class fmpp.models.WritableHash
- WritableSequence - Class in fmpp.models
-
Sequence variable that can be changed during template execution with the proper method variables.
- WritableSequence() - Constructor for class fmpp.models.WritableSequence
- WritableSequence(List) - Constructor for class fmpp.models.WritableSequence
- write(byte[], int, int) - Method in class fmpp.util.NullOutputStream
- write(char[], int, int) - Method in class fmpp.util.NullWriter
- write(int) - Method in class fmpp.util.NullOutputStream
X
- XmlDataLoader - Class in fmpp.dataloaders
-
Returns a variable that exposes the content of an XML file.
- XmlDataLoader() - Constructor for class fmpp.dataloaders.XmlDataLoader
- xmlEnc(String) - Static method in class fmpp.util.StringUtil
-
XML Encoding.
- xmlEncNQ(String) - Static method in class fmpp.util.StringUtil
-
XML encoding without replacing apostrophes and quotation marks.
- XmlInfosetDataLoader - Class in fmpp.dataloaders
-
Deprecated.Use
XmlDataLoader
instead. - XmlInfosetDataLoader() - Constructor for class fmpp.dataloaders.XmlInfosetDataLoader
-
Deprecated.
- XmlRenderingConfiguration - Class in fmpp
-
Stores options that describe when and how to process an XML file in "renderXml" processing mode.
- XmlRenderingConfiguration() - Constructor for class fmpp.XmlRenderingConfiguration
-
Creates new object.
- XPATH_ENGINE_DEFAULT - Static variable in class fmpp.Engine
-
Used as the value of the "xmlEngine" engine parameter: Let FreeMarker choose.
- XPATH_ENGINE_DONT_SET - Static variable in class fmpp.Engine
-
Used as the value of the "xmlEngine" engine parameter: keep the current JVM level setting.
- XPATH_ENGINE_JAXEN - Static variable in class fmpp.Engine
-
Used as the value of the "xmlEngine" engine parameter: Force the usage of Jaxen.
- XPATH_ENGINE_XALAN - Static variable in class fmpp.Engine
-
Used as the value of the "xmlEngine" engine parameter: Force the usage of Xalan.
All Classes All Packages