org.nuiton.i18n.plugin
Class AbstractI18nPlugin

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.i18n.plugin.AbstractI18nPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractI18nParser, Bundle, Generate, Getter

public abstract class AbstractI18nPlugin
extends org.apache.maven.plugin.AbstractMojo

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

Author:

julien

Field Summary

protected java.lang.String	artifactId Nom du projet.
protected java.lang.String	bundles Langues des bundles generes.
protected static java.lang.String	DIRECTORY_INSTALL Répertoire de stockage des fichiers i18n pour la recuperation des fichiers de traduction entre librairie
protected java.lang.String	encoding encoding a utiliser pour charger et sauver les bundles
protected java.util.List<ParserEvent>	events Liste des évènements
protected boolean	genSrc Met les fichiers generes dans le repertoire des sources i18n.
protected boolean	keepBackup conserve les anciens fichiers de traduction avec un suffix ~ Note: par defaut, on ne l'active pas.
protected boolean	keysModifier Active la modification de cle.
protected java.util.Locale[]	locales
protected java.io.File	out Repertoire des fichiers generes i18n.
protected boolean	silent silent flag
protected java.io.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.
protected I18nLogger	verboseLog logger verbeux

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

ROLE

Constructor Summary

AbstractI18nPlugin()

Method Summary

protected void	addGetter() Prend en compte qu'un getter a été détecté.
protected void	addParserEvent(ParserEvent parserEvent) Ajoute un évènement
protected void	backupFile(java.io.File f)
protected void	checkBundle(java.util.Locale locale, java.util.Properties propertiesOut, boolean showEmpty)
protected void	copyFile(java.io.File src, java.io.File dst)
java.lang.String	getArtifactId()
java.io.File	getGetterFile(java.io.File root, java.lang.String getter, boolean create)
java.io.File	getGetterFileBackup(java.io.File root, java.lang.String getter)
java.io.File	getI18nFile(java.io.File root, java.lang.String artifactId, java.util.Locale locale, boolean create)
java.io.File	getI18nFileBackup(java.io.File root, java.lang.String artifactId, java.util.Locale bundle)
protected I18nLogger	getVerboseLog()
void	init()
protected boolean	needGeneration()
protected void	removeParserEvent(ParserEvent parserEvent) Supprime un évènement

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

execute

Field Detail

DIRECTORY_INSTALL

protected static final java.lang.String DIRECTORY_INSTALL

Répertoire de stockage des fichiers i18n pour la recuperation des fichiers de traduction entre librairie

artifactId

protected java.lang.String artifactId

Nom du projet.

bundles

protected java.lang.String bundles

Langues des bundles generes.

src

protected java.io.File src

Repertoire sources des fichiers i18n.

out

protected java.io.File out

Repertoire des fichiers generes i18n.

encoding

protected java.lang.String encoding

encoding a utiliser pour charger et sauver les bundles

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.

keysModifier

protected boolean keysModifier

Active la modification de cle.

Note: par defaut, on ne l'active pas (build sur serveur non ui).

verbose

protected boolean verbose

verbose flag

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

silent

protected boolean silent

silent flag

Since:

1.0.0-rc-5

keepBackup

protected boolean keepBackup

conserve les anciens fichiers de traduction avec un suffix ~

Note: par defaut, on ne l'active pas.

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

events

protected java.util.List<ParserEvent> events

Liste des évènements

locales

protected java.util.Locale[] locales

verboseLog

protected I18nLogger verboseLog

logger verbeux

Constructor Detail

AbstractI18nPlugin

public AbstractI18nPlugin()

Method Detail

addParserEvent

protected void addParserEvent(ParserEvent parserEvent)

Ajoute un évènement

Parameters:

parserEvent - l'évènement d'ajout

removeParserEvent

protected void removeParserEvent(ParserEvent parserEvent)

Supprime un évènement

Parameters:

parserEvent - l'évènement de suppression

init

public void init()

getArtifactId

public java.lang.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.

getVerboseLog

protected I18nLogger getVerboseLog()

getI18nFile

public java.io.File getI18nFile(java.io.File root,
                                java.lang.String artifactId,
                                java.util.Locale locale,
                                boolean create)
                         throws java.io.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:

java.io.IOException - si probleme lors de la creation du fichier

getGetterFile

public java.io.File getGetterFile(java.io.File root,
                                  java.lang.String getter,
                                  boolean create)
                           throws java.io.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:

java.io.IOException - si probleme lors de la creation du fichier

getGetterFileBackup

public java.io.File getGetterFileBackup(java.io.File root,
                                        java.lang.String getter)

Parameters:

root - le repertoire ou sont stockes les fichiers getter

getter - le nom du getter

Returns:

le fichier i18n

getI18nFileBackup

public java.io.File getI18nFileBackup(java.io.File root,
                                      java.lang.String artifactId,
                                      java.util.Locale bundle)

Parameters:

root - le reertoire ou sont stockes les fichiers i18n

artifactId - le nom de l'artifact

bundle - le nom du bundle

Returns:

le fichier i18n de backup

checkBundle

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

backupFile

protected void backupFile(java.io.File f)
                   throws java.io.IOException

Throws:

java.io.IOException

copyFile

protected void copyFile(java.io.File src,
                        java.io.File dst)
                 throws java.io.IOException

Throws:

java.io.IOException