org.apache.maven.plugin.checkstyle
Class VelocityTemplate

java.lang.Object
  org.apache.maven.plugin.checkstyle.VelocityTemplate

public class VelocityTemplate
extends Object

A component to work with VelocityTemplates from within plugins.

You will need to reference the velocity component as a parameter in your plugin. Like this:

 /**
  * Velocity Component
  * @component
  */
  private VelocityComponent velocity;
 

Version:

$Id: VelocityTemplate.java 1155038 2011-08-08 18:23:02Z olamy $

Author:

Joakim Erdfelt

VelocityTemplate

public VelocityTemplate(VelocityComponent velocityComponent,
                        String templateBaseDirectory)

getTemplateDirectory

public String getTemplateDirectory()

getVelocity

public VelocityComponent getVelocity()

generate

public void generate(String outputFilename,
                     String template,
                     Context context)
              throws VelocityException,
                     MojoExecutionException,
                     IOException

Using a specified Velocity Template and provided context, create the outputFilename.

Parameters:

outputFilename - the file to be generated.

template - the velocity template to use.

context - the velocity context map.

Throws:

VelocityException - if the template was not found or any other Velocity exception.

MojoExecutionException

IOException

setTemplateDirectory

public void setTemplateDirectory(String templateDirectory)

setVelocity

public void setVelocity(VelocityComponent velocity)

getLog

public Log getLog()

setLog

public void setLog(Log log)