org.nuiton.i18n.plugin
Class AbstractI18nMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.i18n.plugin.AbstractI18nMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractI18nBundleMojo, AbstractI18nParserMojo, GenerateMojo, GetterMojo

public abstract class AbstractI18nMojo
extends org.nuiton.plugin.AbstractPlugin

Classe permettant d'obenir les parametres pendant les différentes phases du plugin.

Author:

julien

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

protected String	artifactId Nom du projet.
protected String	bundles Langues des bundles generes.
protected String	encoding encoding a utiliser pour charger et sauver les bundles
protected boolean	genSrc Met les fichiers generes dans le repertoire des sources i18n.
protected Locale[]	locales les locales a traiter
protected File	out Repertoire des fichiers generes i18n.
protected org.apache.maven.project.MavenProject	project Dependance du projet.
protected boolean	silent silent flag
protected File	src Repertoire sources des fichiers i18n.
protected boolean	strictMode ne conserve que les clef scannees (et donc traite tous les fichiers) Note : par default, on ne l'active car rescanne tous les fichiers. s
protected boolean	verbose verbose flag Note: si non renseigne, on utilise la propiété maven.verbose.

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

ROLE

Constructor Summary

AbstractI18nMojo()

Method Summary

protected void	addGetter() Prend en compte qu'un getter a été détecté.
protected void	backupFile(File f)
protected void	checkBundle(Locale locale, Properties propertiesOut, boolean showEmpty)
protected boolean	checkPackaging()
String	getArtifactId()
File	getBackupFile(File file)
String	getEncoding()
File	getGetterFile(File root, String getter, boolean create)
File	getI18nFile(File root, String artifactId, Locale locale, boolean create)
org.apache.maven.project.MavenProject	getProject()
void	init()
boolean	isSilent()
boolean	isStrictMode()
boolean	isVerbose()
protected boolean	needGeneration()
void	setEncoding(String encoding)
void	setProject(org.apache.maven.project.MavenProject project)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addTestResourceDir, addUrlToUrlsList, afterExecute, checkResource, checkRunOnceDone, checkSkip, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, doAction, execute, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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

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

getLog, setLog

Field Detail

project

protected org.apache.maven.project.MavenProject project

Dependance du projet.

Since:

1.0.2

Is defined by:

default-value:

${project}

Is required.

artifactId

protected String artifactId

Nom du projet.

Is defined by:

expression:

${i18n.artifactId}

default-value:

${project.artifactId}

Is readonly.

bundles

protected String bundles

Langues des bundles generes.

Is defined by:

expression:

${i18n.bundles}

default-value:

fr_FR,en_GB

Is required.

src

protected File src

Repertoire sources des fichiers i18n.

Is defined by:

expression:

${i18n.src}

default-value:

${basedir}/src/main/resources/i18n

Is required.

out

protected File out

Repertoire des fichiers generes i18n.

Is defined by:

expression:

${i18n.out}

default-value:

${basedir}/target/generated-sources/i18n

Is required.

encoding

protected String encoding

encoding a utiliser pour charger et sauver les bundles

Is defined by:

expression:

${i18n.encoding}

default-value:

${project.build.sourceEncoding}

Is required.

genSrc

protected boolean genSrc

Met les fichiers generes dans le repertoire des sources i18n.

Note: Par défaut active, pour pouvoir paquager avec les bundles mis a jour.

Is defined by:

expression:

${i18n.genSrc}

default-value:

true

verbose

protected boolean verbose

verbose flag

Note: si non renseigne, on utilise la propiété maven.verbose.

Is defined by:

expression:

${i18n.verbose}

default-value:

${maven.verbose}

silent

protected boolean silent

silent flag

Since:

1.0.0-rc-5

Is defined by:

expression:

${i18n.silent}

default-value:

false

strictMode

protected boolean strictMode

ne conserve que les clef scannees (et donc traite tous les fichiers)

Note : par default, on ne l'active car rescanne tous les fichiers. s

Is defined by:

expression:

${i18n.strictMode}

default-value:

false

locales

protected Locale[] locales

les locales a traiter

Constructor Detail

AbstractI18nMojo

public AbstractI18nMojo()

Method Detail

checkPackaging

protected boolean checkPackaging()

Overrides:

checkPackaging in class org.nuiton.plugin.AbstractPlugin

init

public void init()
          throws Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

getArtifactId

public String getArtifactId()

needGeneration

protected boolean needGeneration()

Returns:

true si des getters ont etes enregistres pendant le cycle de vie, false sinon.

addGetter

protected void addGetter()

Prend en compte qu'un getter a été détecté.

Cela veut dire qu'un goal de parser a détecté des clefs. Il faudra donc activer les goal get et gen.

getI18nFile

public File getI18nFile(File root,
                        String artifactId,
                        Locale locale,
                        boolean create)
                 throws IOException

Parameters:

root - le repertoire ou sont stockes les fichiers i18n

artifactId - le nom de l'artifact

locale - le nom du bundle

create - true pour creer le fichier si non present

Returns:

le fichier i18n

Throws:

IOException - si probleme lors de la creation du fichier

getGetterFile

public File getGetterFile(File root,
                          String getter,
                          boolean create)
                   throws IOException

Parameters:

root - le repertoire ou sont stockes les fichiers getter

getter - le nom du getter

create - true pour creer le fichier si non present

Returns:

le fichier i18n

Throws:

IOException - si probleme lors de la creation du fichier

checkBundle

protected void checkBundle(Locale locale,
                           Properties propertiesOut,
                           boolean showEmpty)

getBackupFile

public File getBackupFile(File file)

Overrides:

getBackupFile in class org.nuiton.plugin.AbstractPlugin

backupFile

protected void backupFile(File f)
                   throws IOException

Overrides:

backupFile in class org.nuiton.plugin.AbstractPlugin

Throws:

IOException

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getProject

public org.apache.maven.project.MavenProject getProject()

setProject

public void setProject(org.apache.maven.project.MavenProject project)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

isSilent

public boolean isSilent()

isStrictMode

public boolean isStrictMode()