net.leadware.velocity.maven.plugin.mojo

Class VelocityMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.leadware.velocity.maven.plugin.mojo.VelocityMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="velocity",
      defaultPhase=GENERATE_TEST_RESOURCES,
      threadSafe=true,
      requiresProject=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class VelocityMojo
extends org.apache.maven.plugin.AbstractMojo

Classe representant le MOJO de resolution de template Velocity

Since:

17 févr. 2016 - 22:50:36

Author:

Jean-Jacques ETUNE NGI (Leadware Enterprise Architect)

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	encoding Encodage
private java.io.File	outputDirectory Repertoire de sortie
private org.apache.maven.project.MavenProject	project Projet Maven en cours
private org.apache.maven.model.FileSet	templateFiles Ensemble de fichiers template
private java.util.Properties	templateValues Valeurs de substitution

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
VelocityMojo()

Method Summary

Modifier and Type	Method and Description
private void	addPropertiesToContext(org.apache.velocity.VelocityContext context, java.util.Properties properties) Methode permettant de rajouter des proprietes au contexte
void	execute()
private java.util.List<?>	expandFileSet() Methode permettant d'obtenir la liste des fichiers en entree
private java.lang.String	listToCsvString(java.util.List<?> patterns) Methode permettant de charger transformer la liste de patter de fichiers en chaine CSV
private void	translateFile(org.apache.velocity.app.VelocityEngine engine, java.lang.String basedir, java.lang.String templateFile, org.apache.velocity.VelocityContext context) Methode permettant de transformer un template en resolvant ses variables

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

project

@Component
private org.apache.maven.project.MavenProject project

Projet Maven en cours

encoding

@Parameter(required=false,
           defaultValue="")
private java.lang.String encoding

Encodage

outputDirectory

@Parameter(required=true)
private java.io.File outputDirectory

Repertoire de sortie

templateFiles

@Parameter(required=true)
private org.apache.maven.model.FileSet templateFiles

Ensemble de fichiers template

templateValues

@Parameter(required=true)
private java.util.Properties templateValues

Valeurs de substitution

Constructor Detail

VelocityMojo

public VelocityMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

addPropertiesToContext

private void addPropertiesToContext(org.apache.velocity.VelocityContext context,
                                    java.util.Properties properties)

Methode permettant de rajouter des proprietes au contexte

Parameters:

context - Contexte

properties - Proprietes a rajouter

expandFileSet

private java.util.List<?> expandFileSet()
                                 throws java.io.IOException

Methode permettant d'obtenir la liste des fichiers en entree

Returns:

Liste des fichiers en entree

Throws:

java.io.IOException - Exception potentielle

listToCsvString

private java.lang.String listToCsvString(java.util.List<?> patterns)

Methode permettant de charger transformer la liste de patter de fichiers en chaine CSV

Parameters:

patterns - Liste de pattern

Returns:

Chaine au format CSV

translateFile

private void translateFile(org.apache.velocity.app.VelocityEngine engine,
                           java.lang.String basedir,
                           java.lang.String templateFile,
                           org.apache.velocity.VelocityContext context)
                    throws java.lang.Exception

Methode permettant de transformer un template en resolvant ses variables

Parameters:

basedir - Repertoire de base

templateFile - Fichier template

context - Contexte Velocity

Throws:

java.lang.Exception - Exception potentielle