org.nuiton.i18n.plugin.bundle

Class BundleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.i18n.plugin.AbstractI18nMojo

org.nuiton.i18n.plugin.bundle.AbstractI18nBundleMojo

org.nuiton.i18n.plugin.bundle.BundleMojo

All Implemented Interfaces:

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

@Mojo(name="bundle",
      defaultPhase=GENERATE_RESOURCES,
      requiresProject=true,
      requiresDependencyResolution=RUNTIME)
 @Execute(goal="collect-i18n-artifacts")
public class BundleMojo
extends AbstractI18nBundleMojo

Generate an aggregate i18n bundle for all dependencies of the project. The main idea is to have a final unique i18n bundle for an application to launch, this really improve i18n loading time to have a unique named bundle, no need to seek in all dependencies... Moreover, this permits also to deal with order of i18n keys, more precisely, we want to use the higher level i18n key for an application. If the i18n key is present on a library, we want to be able to override it in application (or user wants it:)). This goal permits this using the dependencies graph order of artifacts.

Since:

0.12

Author:

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

Fields

Modifier and Type	Field and Description
protected File	bundleCsvFile Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead
protected String	bundleCsvSeparator Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead
protected String	bundleFormatConverter Converter used to change format of bundles.
protected Map<String,BundleFormatConverter>	bundleFormatConverters Map of all availables BundleFormatConverter.
protected String	bundleInputEncoding Encoding used to load any i18n property files.
protected File	bundleOutputDir Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
protected String	bundleOutputEncoding Encoding used to write any i18n property files.
protected String	bundleOutputName Name of the bundle to generate.
protected String	bundleOutputPackage Package name of the generate aggregated bundles.
protected BundleValidation	bundleValidation Contains validation result after AbstractI18nMojo.checkBundle(Locale, Properties, boolean, BundleValidation).
protected boolean	checkBundle A flag to check that bundles are complete (no missing i18n translations).
protected BundleFormatConverter	converter Format converter to apply if
protected boolean	failsIfWarning A flag to make the build fails if there is some warnings while generating bundle, says when it misses some translations.
protected boolean	generateCsvFile Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead
protected boolean	generateDefaultLocale A flag to generate a bundle with the first locale defined as a default bundle (with no locale specialization).
protected boolean	generateDefinitionFile A flag to generate the i18n definition file.
protected File	outputFolder The definitive directory where to generate the bundles (includes the package of bundle).
protected boolean	showEmpty A flag to show missing i18n translation.

Fields inherited from class org.nuiton.i18n.plugin.bundle.AbstractI18nBundleMojo

collectOutputDir, collectOutputName

Fields inherited from class org.nuiton.i18n.plugin.AbstractI18nMojo

bundles, encoding, locales, mavenSession, project, silent, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BundleMojo()

Method Summary

Modifier and Type	Method and Description
protected void	applyConversion(Properties properties) Apply conversion over properties with internal converter.
protected void	doAction()
protected void	failsIfWarning()
protected void	generateCsvFile() Generates a csv file with all translations.
protected void	generateDefaultBundle() Generates the default bundle, says the bundle with no locale specialized.
protected void	generateDefinitionFile(String version, Map<Locale,String> bundleDico)
protected File	getBundleFile(File root, String artifactId, Locale locale, boolean create)
String	getBundleInputEncoding()
String	getBundleOutputEncoding()
protected File	getBundleOutputFolder()
protected URL[]	getCollectI18nResources(Locale locale) Pour obtenir les urls des fichiers i18n d'un projet (avec recherche dans ses dépendances).
void	init()

Methods inherited from class org.nuiton.i18n.plugin.bundle.AbstractI18nBundleMojo

getCollectOutputFile

Methods inherited from class org.nuiton.i18n.plugin.AbstractI18nMojo

backupFile, checkBundle, checkPackaging, getBackupFile, getEncoding, getProject, isSilent, isVerbose, setEncoding, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, checkEncoding, checkResource, checkRunOnceDone, checkSkip, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, needInvoke, needInvoke, 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

execute, getLog, setLog

Field Detail

bundleInputEncoding

@Parameter(property="i18n.bundleInputEncoding")
protected String bundleInputEncoding

Encoding used to load any i18n property files. If not defined, will use the AbstractI18nMojo.encoding parameter.

Since:

2.4

bundleOutputEncoding

@Parameter(property="i18n.bundleOutputEncoding")
protected String bundleOutputEncoding

Encoding used to write any i18n property files. If not defined, will use the AbstractI18nMojo.encoding parameter.

Since:

2.4

bundleOutputDir

@Parameter(property="i18n.bundleOutputDir",
           defaultValue="${basedir}/target/generated-sources/resources",
           required=true)
protected File bundleOutputDir

Root directory where to generate aggregated bundles (this directory will be added as resources of the project).

Since:

1.0.0

bundleOutputPackage

@Parameter(property="i18n.bundleOutputPackage",
           defaultValue="META-INF",
           required=true)
protected String bundleOutputPackage

Package name of the generate aggregated bundles. Note: By default we use the META-INF package since it is the favorite package of I18n runtime initializer. The package name is dotted as it will be stored as folder like in Java language. Example :

     package name : foo.bar
     directory    : foo/bar
 

Since:

2.3.2

bundleOutputName

@Parameter(property="i18n.bundleOutputName",
           defaultValue="${project.artifactId}-i18n",
           required=true)
protected String bundleOutputName

Name of the bundle to generate.

Since:

1.0.2

generateDefaultLocale

@Parameter(property="i18n.generateDefaultLocale",
           defaultValue="false")
protected boolean generateDefaultLocale

A flag to generate a bundle with the first locale defined as a default bundle (with no locale specialization).

Since:

2.1

checkBundle

@Parameter(property="i18n.checkBundle",
           defaultValue="true")
protected boolean checkBundle

A flag to check that bundles are complete (no missing i18n translations). Note : This behaviour will be activated is failsIfWarning is on.

Since:

1.0.0

showEmpty

@Parameter(property="i18n.showEmpty",
           defaultValue="false")
protected boolean showEmpty

A flag to show missing i18n translation. Note : Need the checkBundle to be activated).

Since:

1.0.0

failsIfWarning

@Parameter(property="i18n.failsIfWarning",
           defaultValue="false")
protected boolean failsIfWarning

A flag to make the build fails if there is some warnings while generating bundle, says when it misses some translations. Note : This parameter should be used in a release profile to ensure bundles are complete.

Since:

2.0

bundleValidation

protected BundleValidation bundleValidation

Contains validation result after AbstractI18nMojo.checkBundle(Locale, Properties, boolean, BundleValidation). May be null if validation is disabled.

Since:

3.5

outputFolder

protected File outputFolder

The definitive directory where to generate the bundles (includes the package of bundle).

Since:

2.3.2

generateDefinitionFile

@Parameter(property="i18n.generateDefinitionFile",
           defaultValue="true")
protected boolean generateDefinitionFile

A flag to generate the i18n definition file. This file contains all generated bundles and the paths of all i18n artifacts used to make it.

Since:

2.0

generateCsvFile

@Parameter(property="i18n.generateCsvFile",
           defaultValue="false")
 @Deprecated
protected boolean generateCsvFile

Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead

A flag to generate the i18n csv file wich contains all translation for all locales. Useful to translate from a language to another one.

Since:

2.5

bundleCsvFile

@Parameter(property="i18n.bundleCsvFile",
           defaultValue="${basedir}/target/${project.artifactId}-i18n.csv")
 @Deprecated
protected File bundleCsvFile

Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead

Location of the csv file to generate if parameter generateCsvFile is on.

Since:

2.5

bundleCsvSeparator

@Parameter(property="i18n.bundleCsvSeparator",
           defaultValue="\t")
 @Deprecated
protected String bundleCsvSeparator

Deprecated. since 3.3, prefer use the new mojo generate-csv-bundle instead

Char separator used when generating the csv bundle file if parameter generateCsvFile is on.

Since:

2.5

bundleFormatConverter

@Parameter(property="i18n.bundleFormatConverter")
protected String bundleFormatConverter

Converter used to change format of bundles.

Since:

2.4

bundleFormatConverters

@Component(role=BundleFormatConverter.class)
protected Map<String,BundleFormatConverter> bundleFormatConverters

Map of all availables BundleFormatConverter.

Since:

2.4

converter

protected BundleFormatConverter converter

Format converter to apply if

Constructor Detail

BundleMojo

public BundleMojo()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class AbstractI18nMojo

Throws:

Exception

doAction

protected void doAction()
                 throws Exception

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

getBundleFile

protected File getBundleFile(File root,
                             String artifactId,
                             Locale locale,
                             boolean create)
                      throws IOException

Throws:

IOException

generateDefinitionFile

protected void generateDefinitionFile(String version,
                                      Map<Locale,String> bundleDico)
                               throws IOException

Throws:

IOException

getCollectI18nResources

protected URL[] getCollectI18nResources(Locale locale)
                                 throws IOException

Description copied from class: AbstractI18nBundleMojo

Pour obtenir les urls des fichiers i18n d'un projet (avec recherche dans ses dépendances). Note: L'ordre des urls reflète l'ordre des dépendances.

Specified by:

getCollectI18nResources in class AbstractI18nBundleMojo

Parameters:

locale - la locale a traiter

Returns:

les urls des bundles i18n detectees pour le projet.

Throws:

IOException

applyConversion

protected void applyConversion(Properties properties)

Apply conversion over properties with internal converter.

Parameters:

properties - Properties to walk through

Since:

2.4

generateCsvFile

protected void generateCsvFile()
                        throws IOException

Generates a csv file with all translations. First column is key, second is first locale translation, ...

Throws:

IOException - if any IO problem while the copy.

Since:

2.5

failsIfWarning

protected void failsIfWarning()
                       throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

generateDefaultBundle

protected void generateDefaultBundle()
                              throws IOException

Generates the default bundle, says the bundle with no locale specialized. This bundle is a copy of the bundle of the first locale (which in fact is considered as the main locale).

Throws:

IOException - if any IO problem while the copy.

Since:

2.1

getBundleOutputFolder

protected File getBundleOutputFolder()

getBundleOutputEncoding

public String getBundleOutputEncoding()

getBundleInputEncoding

public String getBundleInputEncoding()