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.AbstractMakeI18nBundleMojo

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 AbstractMakeI18nBundleMojo

Generate an aggregate i18n bundle for all dependencies of the project.

The main idea is to have a final unique i18n bundle for a 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 precisly, 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:

tchemit

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 Location of the csv file to generate if parameter generateCsvFile is on.
protected String	bundleCsvSeparator Char separator used when generating the csf bundle file if parameter generateCsvFile is on.
protected String	bundleFormatConverter Converter used to change format of bundles.
protected Map<String,BundleFormatConverter>	bundleFormatConverters Map of all availables BundleFormatConverter.
protected BundleFormatConverter	converter Format converter to apply if
protected boolean	generateCsvFile A flag to generate the i18n csv file wich contains all translation for all locales.
protected boolean	generateDefinitionFile A flag to generate the i18n definition file.

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

bundleInputEncoding, bundleOutputDir, bundleOutputEncoding, bundleOutputName, bundleOutputPackage, checkBundle, failsIfWarning, generateDefaultLocale, outputFolder, showEmpty, unsafeMapping

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

collectOutputDir, collectOutputName

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

artifactId, bundles, encoding, genSrc, locales, out, project, silent, src, strictMode, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BundleMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyConversion(Properties properties) Apply conversion over properties with internal converter.
protected void	doAction()
protected void	generateCsvFile() Generates a csv file with all translations.
protected void	generateDefinitionFile(String version, Map<Locale,String> bundleDico)
protected File	getBundleFile(File root, String artifactId, Locale locale, boolean create) Gets the bundle file for the given parameters.
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.AbstractMakeI18nBundleMojo

failsIfWarning, generateDefaultBundle, getBundleInputEncoding, getBundleOutputEncoding, getBundleOutputFolder

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

getCollectOutputFile

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

addGetter, backupFile, checkBundle, checkPackaging, getArtifactId, getBackupFile, getEncoding, getGetterFile, getI18nFile, getProject, isSilent, isStrictMode, isVerbose, needGeneration, 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, 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

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")
protected boolean generateCsvFile

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")
protected File bundleCsvFile

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

Since:

2.5

bundleCsvSeparator

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

Char separator used when generating the csf 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 AbstractMakeI18nBundleMojo

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

Description copied from class: AbstractMakeI18nBundleMojo

Gets the bundle file for the given parameters.

Specified by:

getBundleFile in class AbstractMakeI18nBundleMojo

Parameters:

root - the root directory where bundles are stored

artifactId - the artifactId (says the prefix of bundle)

locale - the locale used in bundle (null means no locale specialized)

create - a flag to create the file if none existing

Returns:

the bundle file

Throws:

IOException - if any IO problem while creating it (if needed).

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