Google Git
Sign in
apache / freemarker-generator / e8bb62f1ed5a0c365dc3ae164c43428043ddceb1 / . / freemarker-generator-tools
tree: ddef358bbba889566f43ebf6a8e47d07138a80f0 [path history] [tgz]
  1. src/
  2. LICENSE
  3. NOTICE
  4. pom.xml
  5. README.md
freemarker-generator-tools/README.md

Apache FreeMarker Generator Tools

A “tool” is just a POJO (plain old java object) that is “useful” in a template and is not meant to be rendered in the output.

Design Considerations

  • A tool shall expose a default constructor and/or a constructor taking a Map<String, Object> settings
  • A tool processing documents shall provide a parse(Document document) method
  • A tool shall be stateless, multi-thread safe and potentially long-lived to enable usage in a different context
  • A tool shall support arbitrary large source documents and process them efficiently
  • A tool shall expose a toString() method for documentation purposes

Available Tools

The following tools are currently provided

HelperDescription
CSVToolProcess CSV files using Apache Commons CSV
ExecToolExecute command line tools using Apache Commons Exec
ExcelToolProcess Excels files (XLS, XLSX) using Apache POI
FreeMarkerToolExpose useful Apache FreeMarker classes
GrokToolProcess text files using Grok expressions
JsonPathToolProcess JSON files using Java JSON Path
JsoupToolProcess HTML files using Jsoup
PropertiesToolProcess JDK properties files
SystemToolExpose System-related utility methods
XmlToolProcess XML files using Apache FreeMarker
YamlToolProcess YAML files using SnakeYAML
UUIDToolCreate UUIDs