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;
| Constructor and Description |
|---|
VelocityTemplate(org.codehaus.plexus.velocity.VelocityComponent velocityComponent,
String templateBaseDirectory) |
| Modifier and Type | Method and Description |
|---|---|
void |
generate(String outputFilename,
String template,
Context context)
Using a specified Velocity Template and provided context, create the outputFilename.
|
Log |
getLog() |
String |
getTemplateDirectory() |
org.codehaus.plexus.velocity.VelocityComponent |
getVelocity() |
void |
setLog(Log log) |
void |
setTemplateDirectory(String templateDirectory) |
void |
setVelocity(org.codehaus.plexus.velocity.VelocityComponent velocity) |
public VelocityTemplate(org.codehaus.plexus.velocity.VelocityComponent velocityComponent,
String templateBaseDirectory)
public String getTemplateDirectory()
public org.codehaus.plexus.velocity.VelocityComponent getVelocity()
public void generate(String outputFilename, String template, Context context) throws VelocityException, MojoExecutionException, IOException
outputFilename - the file to be generated.template - the velocity template to use.context - the velocity context map.VelocityException - if the template was not found or any other Velocity exception.MojoExecutionExceptionIOExceptionpublic void setTemplateDirectory(String templateDirectory)
public void setVelocity(org.codehaus.plexus.velocity.VelocityComponent velocity)
public Log getLog()
public void setLog(Log log)
Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.