VelocityTemplatingEngine

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Represents a fluent, easy-to-use façade over the org.apache.velocity.app.VelocityEngine used by the JIRA web application.

Usage

File Templates

• To render a file template, applying a map of parameters as html:
  engine.render(file("path/to/file")).applying(parameters).asHtml()
• if there are no params to the template you can omit the applying call:
  engine.render(file("path/to/file")).asHtml()
• To render the template as plain text:
  engine.render(file("path/to/file")).asPlainText()

Fragments

• To render a vtl fragment stored in a string, applying a map of parameters as html:
  engine.render(fragment("vtl-fragment")).applying(parameters).asHtml()
• if there are no params to the template you can omit the applying call:
  engine.render(fragment("vtl-fragment")).asHtml()
• To render the template as plain text:
  engine.render(file("path/to/file")).asPlainText()

Summary