com.brambolt.gradle.velocity

Class TemplateVisitor

java.lang.Object

org.gradle.api.file.EmptyFileVisitor

com.brambolt.gradle.velocity.TemplateVisitor

All Implemented Interfaces:

org.gradle.api.file.FileVisitor

public class TemplateVisitor
extends org.gradle.api.file.EmptyFileVisitor

Utility class for applying a Velocity engine with a file visitation pattern.

Constructor Summary

Constructors

Constructor and Description
TemplateVisitor(Velocity task, org.apache.velocity.app.VelocityEngine engine) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.velocity.VelocityContext	getContext() Converts the configured task context to a Velocity context.
java.io.File	getOutputFile(org.gradle.api.file.FileVisitDetails details) Produces a file from the visit details.
void	visitFile(org.gradle.api.file.FileVisitDetails details) Visits the templates.

Methods inherited from class org.gradle.api.file.EmptyFileVisitor

visitDir

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateVisitor

public TemplateVisitor(Velocity task,
                       org.apache.velocity.app.VelocityEngine engine)

Constructor.

Parameters:

task - The Velocity task.

engine - The Velocity engine.

Method Detail

visitFile

public void visitFile(org.gradle.api.file.FileVisitDetails details)

Visits the templates.

Specified by:

visitFile in interface org.gradle.api.file.FileVisitor

Overrides:

visitFile in class org.gradle.api.file.EmptyFileVisitor

Parameters:

details - The visitation details.

getOutputFile

public java.io.File getOutputFile(org.gradle.api.file.FileVisitDetails details)

Produces a file from the visit details.

Parameters:

details - The visit details.

Returns:

A file matching the visit details.

getContext

public org.apache.velocity.VelocityContext getContext()

Converts the configured task context to a Velocity context.

Returns:

The Velocity context, .