com.brambolt.gradle.velocity.tasks

Class Velocity

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.brambolt.gradle.velocity.tasks.Velocity

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class Velocity
extends org.gradle.api.DefaultTask

A Gradle task for instantiating Velocity templates using the Velocity engine.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VELOCITY_INPUT_PATH The default input path to locate template files with.
static java.lang.String	DEFAULT_VELOCITY_TASK_NAME The default task name.

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
Velocity()

Method Summary

Modifier and Type	Method and Description
void	apply() Executes the task.
protected java.util.Map<java.io.File,java.util.List<java.lang.String>>	checkCompleteInstantiation(java.io.File dir) Creates a map of instantated template files to the list of lines in the files where a template variable failed to be instantiated.
protected void	checkExecution() Checks that the task executed correctly.
java.util.List<java.lang.String>	checkInstantiation(java.nio.file.Path instantiated) Returns a list of lines with uninstantiated template variables, from the parameter file.
org.gradle.api.Task	configure(groovy.lang.Closure closure) Configures the task.
void	configureDefaults() Applies default values.
java.util.Map<java.lang.String,java.lang.Object>	context(groovy.lang.Closure<java.lang.Void> closure) Applies the parameter closure to the template context.
java.util.Map<java.lang.String,java.lang.Object>	context(java.io.File propertiesFile) Adds the key-value pairs in the parameter properties file to the context.
java.util.Map<java.lang.String,java.lang.Object>	context(java.io.InputStream propertiesStream) Adds the key-value pairs in the parameter properties stream to the context.
java.util.Map<java.lang.String,java.lang.Object>	context(java.util.Map<java.lang.String,java.lang.Object> values) Adds the key-value pairs in the parameter map to the Velocity context.
org.apache.velocity.app.VelocityEngine	createEngine(org.gradle.api.file.FileTree inputFiles) Creates a Velocity engine instance for the input files.
TemplateVisitor	createVisitor(org.apache.velocity.app.VelocityEngine engine) Creates a template visitor for the parameter engine.
java.util.Map<java.lang.String,java.lang.Object>	getContext() The Velocity template context for instantiation.
java.util.Map<java.lang.String,java.lang.Object>	getContextValues() Getter.
groovy.lang.Closure<java.io.File>	getInputFile() The directory where the templates are located.
org.gradle.api.file.FileTree	getInputFiles() Converts the input directory to a file tree.
java.lang.String	getInputPath() Accessor.
java.io.File	getOutputDir() The output directory to write the instantiated templates to.
boolean	isSort() Getter.
boolean	isStrict() Getter.
boolean	isUninstantiated(java.lang.String line) Determines whether a line has an uninstantiated variable.
void	setContextValues(java.util.Map<java.lang.String,java.lang.Object> contextValues) Setter.
void	setInputPath(java.lang.String inputPath) Setter.
void	setOutputDir(java.io.File outputDir) Setter.
void	setSort(boolean sort) Setter.
void	setStrict(boolean strict) Setter.
void	throwIfUninstantiated(java.util.Map<java.io.File,java.util.List<java.lang.String>> uninstantiated) Throws a Gradle exception if the parameter map is non-empty.

Methods inherited from class org.gradle.api.DefaultTask

compareTo, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Field Detail

DEFAULT_VELOCITY_INPUT_PATH

public static final java.lang.String DEFAULT_VELOCITY_INPUT_PATH

The default input path to locate template files with.

See Also:

Constant Field Values

DEFAULT_VELOCITY_TASK_NAME

public static final java.lang.String DEFAULT_VELOCITY_TASK_NAME

The default task name.

See Also:

Constant Field Values

Constructor Detail

Velocity

public Velocity()

Method Detail

getInputPath

public java.lang.String getInputPath()

Accessor.

Returns:

The input path.

setInputPath

public void setInputPath(java.lang.String inputPath)

Setter.

Parameters:

inputPath - The input path to use.

getOutputDir

public java.io.File getOutputDir()

The output directory to write the instantiated templates to. Defaults to <buildDir>/velocity.

Returns:

The output directory

setOutputDir

public void setOutputDir(java.io.File outputDir)

Setter.

Parameters:

outputDir - The output directory to use.

getContextValues

public java.util.Map<java.lang.String,java.lang.Object> getContextValues()

Getter.

Returns:

The context value map.

setContextValues

public void setContextValues(java.util.Map<java.lang.String,java.lang.Object> contextValues)

Setter.

Parameters:

contextValues - The context values to set.

isStrict

public boolean isStrict()

Getter.

Returns:

True iff the instantiation is strict.

setStrict

public void setStrict(boolean strict)

Setter.

Parameters:

strict - The strictness flag to set.

isSort

public boolean isSort()

Getter.

Returns:

True iff the instantiation sorts.

setSort

public void setSort(boolean sort)

Setter.

Parameters:

sort - The sorting flag to set.

getInputFile

@Optional
 @InputDirectory
public groovy.lang.Closure<java.io.File> getInputFile()

The directory where the templates are located. Defaults to src/main/templates.

Returns:

The input directory that holds the templates

getContext

@Input
public java.util.Map<java.lang.String,java.lang.Object> getContext()

The Velocity template context for instantiation.

Returns:

The instantiation context

context

public java.util.Map<java.lang.String,java.lang.Object> context(groovy.lang.Closure<java.lang.Void> closure)

Applies the parameter closure to the template context. Syntactic sugar.

Parameters:

closure - A closure to add values to the Velocity context

Returns:

The resulting Velocity context after the closure has been called

context

public java.util.Map<java.lang.String,java.lang.Object> context(java.util.Map<java.lang.String,java.lang.Object> values)

Adds the key-value pairs in the parameter map to the Velocity context.

Parameters:

values - The values to add

Returns:

The Velocity context after the values have been added

context

public java.util.Map<java.lang.String,java.lang.Object> context(java.io.InputStream propertiesStream)

Adds the key-value pairs in the parameter properties stream to the context.

Parameters:

propertiesStream - A stream opened from a Java properties file or equivalent

Returns:

The Velocity context after the values have been added

context

public java.util.Map<java.lang.String,java.lang.Object> context(java.io.File propertiesFile)

Adds the key-value pairs in the parameter properties file to the context.

Parameters:

propertiesFile - The Java properties file to add

Returns:

The Velocity context after the values have been added

configure

public org.gradle.api.Task configure(groovy.lang.Closure closure)

Configures the task. This method is re-entrant, the task can be configured any number of times, or not at all.

Specified by:

configure in interface org.gradle.api.Task

Specified by:

configure in interface org.gradle.util.Configurable<org.gradle.api.Task>

Overrides:

configure in class org.gradle.api.DefaultTask

Parameters:

closure - The configuration closure

Returns:

The configured task

configureDefaults

public void configureDefaults()

Applies default values.

apply

public void apply()

Executes the task.

getInputFiles

@Internal
public org.gradle.api.file.FileTree getInputFiles()

Converts the input directory to a file tree.

Returns:

The file tree of the input files.

createVisitor

public TemplateVisitor createVisitor(org.apache.velocity.app.VelocityEngine engine)

Creates a template visitor for the parameter engine.

Parameters:

engine - The Velocity engine being used

Returns:

A template visitor for the engine

See Also:

TemplateVisitor

createEngine

public org.apache.velocity.app.VelocityEngine createEngine(org.gradle.api.file.FileTree inputFiles)

Creates a Velocity engine instance for the input files.

Parameters:

inputFiles - The input files to instantiate as Velocity templates

Returns:

A Velocity engine to instantiate the parameter files

checkExecution

protected void checkExecution()

Checks that the task executed correctly.

Throws:

org.gradle.api.GradleException - If the task did not complete template instantiation.

checkCompleteInstantiation

protected java.util.Map<java.io.File,java.util.List<java.lang.String>> checkCompleteInstantiation(java.io.File dir)

Creates a map of instantated template files to the list of lines in the files where a template variable failed to be instantiated. If every variable has a context value then the map will be empty; if one or more variables are missing from the context then one or more files will appear in the output, and map to the lines where instantiation failed.

Parameters:

dir - The directory containing the instantiated templates to check

Returns:

The map of files to lines with uninstantiated variables

checkInstantiation

public java.util.List<java.lang.String> checkInstantiation(java.nio.file.Path instantiated)

Returns a list of lines with uninstantiated template variables, from the parameter file. The output is empty if everything was instantiated.

Parameters:

instantiated - The file to check

Returns:

The lines with uninstantiated template variables

isUninstantiated

public boolean isUninstantiated(java.lang.String line)

Determines whether a line has an uninstantiated variable. The check simply looks for the start of a variable insertion, e.g. ${. This probably fails in a lot of cases, but has proven sufficiently useful for a lot of cases.

Parameters:

line - The line to check

Returns:

True iff the line contains the ${ pattern

throwIfUninstantiated

public void throwIfUninstantiated(java.util.Map<java.io.File,java.util.List<java.lang.String>> uninstantiated)

Throws a Gradle exception if the parameter map is non-empty.

Parameters:

uninstantiated - The map of uninstantiated template variable occurrences