org.nuiton.i18n.plugin.bundle

Class AbstractMakeI18nBundleMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BundleMojo, TapestryBundleMojo

public abstract class AbstractMakeI18nBundleMojo
extends AbstractI18nBundleMojo

Common mojo to all final bundle maker.

Since:

2.0

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 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 boolean	checkBundle A flag to check that bundles are complete (no missing i18n translations).
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	generateDefaultLocale A flag to generate a bundle with the first locale defined as a default bundle (with no locale specialization).
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.
protected Map<Locale,SortedSet<String>>	unsafeMapping to keep all none translated i18n keys by locale.

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
AbstractMakeI18nBundleMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	failsIfWarning()
protected void	generateDefaultBundle() Generates the default bundle, says the bundle with no locale specialized.
protected abstract File	getBundleFile(File root, String artifactId, Locale locale, boolean create) Gets the bundle file for the given parameters.
String	getBundleInputEncoding()
String	getBundleOutputEncoding()
protected File	getBundleOutputFolder()
void	init()

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

getCollectI18nResources, 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, doAction, 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

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

unsafeMapping

protected Map<Locale,SortedSet<String>> unsafeMapping

to keep all none translated i18n keys by locale.

outputFolder

protected File outputFolder

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

Since:

2.3.2

Constructor Detail

AbstractMakeI18nBundleMojo

public AbstractMakeI18nBundleMojo()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class AbstractI18nMojo

Throws:

Exception

failsIfWarning

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

Throws:

org.apache.maven.plugin.MojoFailureException

getBundleFile

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

Gets the bundle file for the given parameters.

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

Since:

2.1

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()