org.apache.maven.plugins.checkstyle.rss

Class VelocityTemplate

java.lang.Object

org.apache.maven.plugins.checkstyle.rss.VelocityTemplate

Deprecated.

@Deprecated
public class VelocityTemplate
extends Object

A component to work with Velocity templates 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;
 

Author:

Joakim Erdfelt

Constructor Summary

Constructors

Constructor and Description
VelocityTemplate(org.codehaus.plexus.velocity.VelocityComponent velocityComponent, String templateBaseDirectory) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	generate(String outputFilename, String template, org.apache.velocity.context.Context context) Deprecated. Using a specified Velocity Template and provided context, create the outputFilename.
org.apache.maven.plugin.logging.Log	getLog() Deprecated.
String	getTemplateDirectory() Deprecated.
org.codehaus.plexus.velocity.VelocityComponent	getVelocity() Deprecated.
void	setLog(org.apache.maven.plugin.logging.Log log) Deprecated.
void	setTemplateDirectory(String templateDirectory) Deprecated.
void	setVelocity(org.codehaus.plexus.velocity.VelocityComponent velocity) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityTemplate

public VelocityTemplate(org.codehaus.plexus.velocity.VelocityComponent velocityComponent,
                        String templateBaseDirectory)

Deprecated.

Method Detail

getTemplateDirectory

public String getTemplateDirectory()

Deprecated.

getVelocity

public org.codehaus.plexus.velocity.VelocityComponent getVelocity()

Deprecated.

generate

public void generate(String outputFilename,
                     String template,
                     org.apache.velocity.context.Context context)
              throws org.apache.velocity.exception.VelocityException,
                     org.apache.maven.plugin.MojoExecutionException,
                     IOException

Deprecated.

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:

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

org.apache.maven.plugin.MojoExecutionException - if merging the velocity template failed

IOException - if there was an error writing to the output file

setTemplateDirectory

public void setTemplateDirectory(String templateDirectory)

Deprecated.

setVelocity

public void setVelocity(org.codehaus.plexus.velocity.VelocityComponent velocity)

Deprecated.

getLog

public org.apache.maven.plugin.logging.Log getLog()

Deprecated.

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

Deprecated.