A C D E G I S T V

A

apply(FileCollection) - Method in class com.brambolt.gradle.velocity.EngineFactory

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

apply(File) - Method in class com.brambolt.gradle.velocity.InputFiles

Produces a file tree from the parameter base file.

apply() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Executes the task.

apply(Project) - Method in class com.brambolt.gradle.VelocityPlugin

Applies the plug-in to the parameter project.

C

checkCompleteInstantiation(File) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Creates a map of instantated template files to the list of lines in the files where a template variable failed to be instantiated.

checkExecution() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Checks that the task executed correctly.

checkInstantiation(Path) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Returns a list of lines with uninstantiated template variables, from the parameter file.

com.brambolt.gradle - package com.brambolt.gradle

com.brambolt.gradle.velocity - package com.brambolt.gradle.velocity

com.brambolt.gradle.velocity.tasks - package com.brambolt.gradle.velocity.tasks

configure(Closure) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Configures the task.

configureDefaults() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Applies default values.

context(Closure<Void>) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Applies the parameter closure to the template context.

context(Map<String, Object>) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

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

context(InputStream) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

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

context(File) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

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

createEngine(FileTree) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Creates a Velocity engine instance for the input files.

createTemplatesTask(Project) - Method in class com.brambolt.gradle.VelocityPlugin

Creates a Velocity template instantiation task named velocity.

createTemplatesTask(Project, String) - Method in class com.brambolt.gradle.VelocityPlugin

Creates a Velocity template instantiation task with the parameter name.

createVisitor(VelocityEngine) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Creates a template visitor for the parameter engine.

D

DEFAULT_VELOCITY_INPUT_PATH - Static variable in class com.brambolt.gradle.velocity.tasks.Velocity

The default input path to locate template files with.

DEFAULT_VELOCITY_TASK_NAME - Static variable in class com.brambolt.gradle.velocity.tasks.Velocity

The default task name.

E

EngineFactory - Class in com.brambolt.gradle.velocity

Sets up a Velocity engine for instantiating templates.

EngineFactory() - Constructor for class com.brambolt.gradle.velocity.EngineFactory

Constructor.

EngineFactory(Project) - Constructor for class com.brambolt.gradle.velocity.EngineFactory

Constructor.

G

getContext() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

The Velocity template context for instantiation.

getContext() - Method in class com.brambolt.gradle.velocity.TemplateVisitor

Converts the configured task context to a Velocity context.

getContextValues() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Getter.

getEmptyInput() - Method in class com.brambolt.gradle.velocity.InputFiles

Produces an empty file tree.

getFileTreeInput(File) - Method in class com.brambolt.gradle.velocity.InputFiles

Produces a file tree rooted at the parameter input directory, containing the files that match the input mask.

getInputFile() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

The directory where the templates are located.

getInputFiles() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Converts the input directory to a file tree.

getInputPath() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Accessor.

getInputs(FileCollection) - Method in class com.brambolt.gradle.velocity.EngineFactory

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

getOutputDir() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

The output directory to write the instantiated templates to.

getOutputFile(FileVisitDetails) - Method in class com.brambolt.gradle.velocity.TemplateVisitor

Produces a file from the visit details.

getSingleFileInput(File) - Method in class com.brambolt.gradle.velocity.InputFiles

Products a file tree for a temporary copy of the single file parameter, without checking the input mask.

I

InputFiles - Class in com.brambolt.gradle.velocity

Utility class for converting a directory to a file tree.

InputFiles(Project) - Constructor for class com.brambolt.gradle.velocity.InputFiles

Constructor.

InputFiles(Project, String) - Constructor for class com.brambolt.gradle.velocity.InputFiles

Constructor.

isSort() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Getter.

isStrict() - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Getter.

isUninstantiated(String) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Determines whether a line has an uninstantiated variable.

S

setContextValues(Map<String, Object>) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Setter.

setInputPath(String) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Setter.

setOutputDir(File) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Setter.

setProperty(VelocityEngine, String, Object) - Method in class com.brambolt.gradle.velocity.EngineFactory

Sets a property on the parameter engine.

setSort(boolean) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Setter.

setStrict(boolean) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

Setter.

T

TemplateVisitor - Class in com.brambolt.gradle.velocity

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

TemplateVisitor(Velocity, VelocityEngine) - Constructor for class com.brambolt.gradle.velocity.TemplateVisitor

Constructor.

throwIfUninstantiated(Map<File, List<String>>) - Method in class com.brambolt.gradle.velocity.tasks.Velocity

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

V

Velocity - Class in com.brambolt.gradle.velocity.tasks

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

Velocity() - Constructor for class com.brambolt.gradle.velocity.tasks.Velocity

VelocityPlugin - Class in com.brambolt.gradle

A Gradle plug-in for working with Velocity templates.

VelocityPlugin(FileResolver) - Constructor for class com.brambolt.gradle.VelocityPlugin

Constructor.

visitFile(FileVisitDetails) - Method in class com.brambolt.gradle.velocity.TemplateVisitor

Visits the templates.

A C D E G I S T V