org.nuiton.i18n.plugin.parser.impl

Class ParserGWTJavaMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.i18n.plugin.AbstractI18nMojo

org.nuiton.i18n.plugin.parser.AbstractI18nParserMojo

org.nuiton.i18n.plugin.parser.impl.ParserGWTJavaMojo

All Implemented Interfaces:

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

@Mojo(name="parserGWTJava",
      defaultPhase=GENERATE_RESOURCES)
public class ParserGWTJavaMojo
extends AbstractI18nParserMojo

To detect from GWT java files new I18n keys, says content of patterns :

• @Key("XXX")
• @LocalizableResource.Key("XXX")
• @com.google.gwt.i18n.client.LocalizableResource.Key("XXX")

Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.

Since:

2.1

Author:

tchemit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ParserGWTJavaMojo.GWTJavaFileParser
static class	ParserGWTJavaMojo.GWTJavaProcessor To Extract i18n keys from GWT java files.

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
static String	DEFAULT_INCLUDES
protected File	defaultBasedir Root directory of the default entry.
protected String	defaultIncludes Default included files to process (ant-like expression).
protected org.nuiton.io.MirroredFileUpdater	entryUpdater
protected String	outputGetter Defines the file name of the getter where to put detected i18n keys while getter phase.
protected File	workdir Where to generated temporary processed files.

Fields inherited from class org.nuiton.i18n.plugin.parser.AbstractI18nParserMojo

acceptKeyFormat, acceptPattern, backupGetter, cp, entries, force, oldLanguage, oldParser, showTouchedFiles, t0, treateDefaultEntry

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

Method Summary

Methods

Modifier and Type	Method and Description
File	getDefaultBasedir()
String[]	getDefaultExcludes()
String[]	getDefaultIncludes()
protected String	getOutGetter()
FileParser	newFileParser(Pattern acceptPattern)
org.nuiton.io.FileUpdater	newFileUpdater(SourceEntry entry)
protected boolean	onEnterEntry(I18nSourceEntry entry)

Methods inherited from class org.nuiton.i18n.plugin.parser.AbstractI18nParserMojo

addDefaultEntry, doAction, getLogEntry, getResult, init, isForce, isShowTouchedFiles, isStrictMode, saveGetterFile

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

addGetter, backupFile, checkBundle, checkPackaging, getArtifactId, getBackupFile, getEncoding, getGetterFile, getI18nFile, getProject, isSilent, 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.nuiton.i18n.plugin.parser.I18nParserConfiguration

getLog, isSilent, isVerbose

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

execute, getLog, setLog

Field Detail

DEFAULT_INCLUDES

public static final String DEFAULT_INCLUDES

See Also:

Constant Field Values

defaultBasedir

@Parameter(property="i18n.defaultBasedir",
           defaultValue="${basedir}/src/main/java")
protected File defaultBasedir

Root directory of the default entry.

defaultIncludes

@Parameter(property="i18n.defaultIncludes",
           defaultValue="**/*.java",
           required=true)
protected String defaultIncludes

Default included files to process (ant-like expression).

Note: default value is **\/*.java

outputGetter

@Parameter(property="i18n.outputGetter",
           defaultValue="gwt-java.getter")
protected String outputGetter

Defines the file name of the getter where to put detected i18n keys while getter phase.

Since:

2.0

workdir

@Parameter(property="i18n.workdir",
           defaultValue="${basedir}/target/i18n-workdir")
protected File workdir

Where to generated temporary processed files.

Since:

2.0

entryUpdater

protected org.nuiton.io.MirroredFileUpdater entryUpdater

Constructor Detail

ParserGWTJavaMojo

public ParserGWTJavaMojo()

Method Detail

getDefaultIncludes

public String[] getDefaultIncludes()

Specified by:

getDefaultIncludes in class AbstractI18nParserMojo

Returns:

the default includes to add to directory scanner

getDefaultExcludes

public String[] getDefaultExcludes()

Specified by:

getDefaultExcludes in class AbstractI18nParserMojo

Returns:

the default excludes to add to directory scanner

getDefaultBasedir

public File getDefaultBasedir()

Specified by:

getDefaultBasedir in class AbstractI18nParserMojo

Returns:

the default src directory to use in directory scanner

onEnterEntry

protected boolean onEnterEntry(I18nSourceEntry entry)

Overrides:

onEnterEntry in class AbstractI18nParserMojo

newFileUpdater

public org.nuiton.io.FileUpdater newFileUpdater(SourceEntry entry)

Specified by:

newFileUpdater in class AbstractI18nParserMojo

Parameters:

entry - the incoming source entry to attach to the file updater

Returns:

a new file updater to detects files to treate

getOutGetter

protected String getOutGetter()

Specified by:

getOutGetter in class AbstractI18nParserMojo

Returns:

the outGetter to use for the instance (java.getter,...)

newFileParser

public FileParser newFileParser(Pattern acceptPattern)

Specified by:

newFileParser in class AbstractI18nParserMojo

Parameters:

acceptPattern - optional pattern to accept incoming keys

Returns:

a new file parser to be used in the parser consumer parserExecutor