Package org.apache.maven.plugins.checkstyle.rss

Class VelocityTemplate

  • public class VelocityTemplate
extends java.lang.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$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.apache.maven.plugin.logging.Log log  
      private java.lang.String templateDirectory  
      private org.codehaus.plexus.velocity.VelocityComponent velocity  

    • Constructor Summary

      Constructors 
      Constructor Description
      VelocityTemplate​(org.codehaus.plexus.velocity.VelocityComponent velocityComponent, java.lang.String templateBaseDirectory)  

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • templateDirectory

        private java.lang.String templateDirectory

      • log

        private org.apache.maven.plugin.logging.Log log

      • velocity

        private org.codehaus.plexus.velocity.VelocityComponent velocity

    • Constructor Detail

      • VelocityTemplate

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

    • Method Detail

      • getTemplateDirectory

        public java.lang.String getTemplateDirectory()

      • getVelocity

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

      • generate

        public void generate​(java.lang.String outputFilename,
                     java.lang.String template,
                     org.apache.velocity.context.Context context)
              throws org.apache.velocity.exception.VelocityException,
                     org.apache.maven.plugin.MojoExecutionException,
                     java.io.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:
        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.
        java.io.IOException - if there was an error when writing to the output file.

      • setTemplateDirectory

        public void setTemplateDirectory​(java.lang.String templateDirectory)

      • setVelocity

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

      • getLog

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

      • setLog

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