com.brambolt.gradle.velocity

Class EngineFactory

java.lang.Object

com.brambolt.gradle.velocity.EngineFactory

public class EngineFactory
extends java.lang.Object

Sets up a Velocity engine for instantiating templates.

Constructor Summary

Constructors

Constructor and Description
EngineFactory() Constructor.
EngineFactory(org.gradle.api.Project project) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.velocity.app.VelocityEngine	apply(org.gradle.api.file.FileCollection inputFiles) Factory method - creates a Velocity engine for the parameter input files.
java.lang.String	getInputs(org.gradle.api.file.FileCollection inputFiles) Converts the parameter file collection to a comma-separated list of absolute paths.
void	setProperty(org.apache.velocity.app.VelocityEngine engine, java.lang.String name, java.lang.Object value) Sets a property on the parameter engine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EngineFactory

public EngineFactory()

Constructor. The resulting engine factory will not log anything.

EngineFactory

public EngineFactory(org.gradle.api.Project project)

Constructor. The resulting engine factory will log property assignments.

Parameters:

project - The Gradle project the engine factory is for

Method Detail

apply

public org.apache.velocity.app.VelocityEngine apply(org.gradle.api.file.FileCollection inputFiles)

Factory method - creates a Velocity engine for the parameter input files.

Parameters:

inputFiles - The root directory of the templates to instantiate

Returns:

A Velocity engine to instantiate the templates with

setProperty

public void setProperty(org.apache.velocity.app.VelocityEngine engine,
                        java.lang.String name,
                        java.lang.Object value)

Sets a property on the parameter engine.

Parameters:

engine - The engine to set the property on

name - The property name

value - The property value

getInputs

public java.lang.String getInputs(org.gradle.api.file.FileCollection inputFiles)

Converts the parameter file collection to a comma-separated list of absolute paths.

Parameters:

inputFiles - The input files as a file collection

Returns:

The input files as a comma-separate list of absolute paths