Package org.nuiton.i18n.plugin
Class GenerateMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.nuiton.plugin.AbstractPlugin
org.nuiton.i18n.plugin.AbstractI18nMojo
org.nuiton.i18n.plugin.AbstractI18nGenerateMojo
org.nuiton.i18n.plugin.GenerateMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo,org.nuiton.plugin.Plugin,org.nuiton.plugin.PluginWithEncoding
@Mojo(name="gen",
defaultPhase=GENERATE_RESOURCES)
@Execute(goal="get")
public class GenerateMojo
extends AbstractI18nGenerateMojo
Merge new generated i18n bundles with older existing ones.
- Author:
- Julien Ruchaud - ruchaud@codelutin.com, Tony Chemit - chemit@codelutin.com
-
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
FieldsModifier and TypeFieldDescriptionprotected BundleValidationprotected booleanA flag to check that bundles are complete (no missing i18n translations).protected booleanA flag to make the build fails if there is some missing keys.protected booleanA flag to make the build fails if there is some missing key values.protected booleanDeprecated.protected booleanTo update generated files to user i18n files.protected booleanTo keep a backup of old i18n bundles (suffiex by a~).protected booleanTo keep generated getter files.protected booleanA flag to show missing i18n translation.protected FileDirectory where to find project i18n files.protected booleanStrict mode to only keep in user i18n detected i18n keys and remove obsolete keys.Fields inherited from class org.nuiton.i18n.plugin.AbstractI18nGenerateMojo
artifactId, outFields inherited from class org.nuiton.i18n.plugin.AbstractI18nMojo
bundles, encoding, locales, mavenSession, project, silent, verboseFields inherited from interface org.apache.maven.plugin.Mojo
ROLE -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class org.nuiton.i18n.plugin.AbstractI18nGenerateMojo
addGetter, getGetterFile, needGenerationMethods inherited from class org.nuiton.i18n.plugin.AbstractI18nMojo
backupFile, checkBundle, checkPackaging, failsIfAnyKeyMissingInBundle, failsIfAnyKeyMissingValue, getBackupFile, getEncoding, getProject, init, isSilent, isVerbose, setEncoding, setProject, setVerboseMethods inherited from class org.nuiton.plugin.AbstractPlugin
acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, checkEncoding, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, needInvoke, needInvoke, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFileMethods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContextMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.maven.plugin.Mojo
execute, getLog, setLog
-
Field Details
-
src
@Parameter(property="i18n.src", defaultValue="${basedir}/src/main/resources/i18n", required=true) protected File srcDirectory where to find project i18n files. -
genSrc
@Parameter(property="i18n.genSrc", defaultValue="true") protected boolean genSrcTo update generated files to user i18n files. Note : By default, this is active, in order to have a project uptodate with last i18n bundles detected. -
strictMode
@Parameter(property="i18n.strictMode", defaultValue="false") protected boolean strictModeStrict mode to only keep in user i18n detected i18n keys and remove obsolete keys. Note : By default not active. Use this with care since it can delete keys. Moreover if this flag is activated, then all files will be parsed. -
checkBundle
@Parameter(property="i18n.checkBundle", defaultValue="true", required=true) protected boolean checkBundleA flag to check that bundles are complete (no missing i18n translations).- Since:
- 1.0.0
-
showEmpty
@Parameter(property="i18n.showEmpty", defaultValue="false", required=true) protected boolean showEmptyA flag to show missing i18n translation. Note : Need thecheckBundleto be activated).- Since:
- 1.0.0
-
failsIfWarning
@Parameter(property="i18n.failsIfWarning", defaultValue="false") @Deprecated protected boolean failsIfWarningDeprecated. -
failsIfAnyKeyMissingValue
@Parameter(property="i18n.failsIfAnyKeyMissingValue", defaultValue="false") protected boolean failsIfAnyKeyMissingValueA flag to make the build fails if there is some missing key values. Note : This parameter should be used in a release profile to ensure bundles are complete.- Since:
- 3.5.1
-
failsIfAnyKeyMissingInBundle
@Parameter(property="i18n.failsIfAnyKeyMissingInBundle", defaultValue="false") protected boolean failsIfAnyKeyMissingInBundleA flag to make the build fails if there is some missing keys. Note : This parameter should be used in a release profile to ensure bundles are complete.- Since:
- 3.5.1
-
keepBackup
@Parameter(property="i18n.keepBackup", defaultValue="false") protected boolean keepBackupTo keep a backup of old i18n bundles (suffiex by a~). Note: By default, this property is not active. -
keepGetters
@Parameter(property="i18n.keepGetters", defaultValue="false") protected boolean keepGettersTo keep generated getter files. Note: By default, this property is not active. -
bundleValidation
-
-
Constructor Details
-
GenerateMojo
public GenerateMojo()
-
-
Method Details
-
checkSkip
protected boolean checkSkip()- Overrides:
checkSkipin classorg.nuiton.plugin.AbstractPlugin
-
doAction
- Specified by:
doActionin classorg.nuiton.plugin.AbstractPlugin- Throws:
Exception
-