Package org.nuiton.i18n.plugin.parser.impl

Class ParserXmlUserMojo

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.parser.AbstractI18nParserMojo

org.nuiton.i18n.plugin.parser.impl.AbstractParserXmlMojo

org.nuiton.i18n.plugin.parser.impl.ParserXmlUserMojo

All Implemented Interfaces:

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

@Mojo(name="parserXml",
      defaultPhase=GENERATE_RESOURCES)
public class ParserXmlUserMojo
extends AbstractParserXmlMojo

To obtain i18n keys from xml files using the userRulesFiles (and an optional coreRuleFile if any serves your purpose). Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.

Since:

2.0

Author:

Tony Chemit - chemit@codelutin.com

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.i18n.plugin.parser.impl.AbstractParserXmlMojo

AbstractParserXmlMojo.XmlFileParser

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	Description
protected File	basedir	Default directory where to look for files.
protected String	coreRuleFile	Defines an optional files which contain xpath rules to obtain i18n keys in xml files and is defined in plugin.
protected String	includes	Defines files to parse.
protected String	outputGetter	Defines the file name of the getter where to put detected i18n keys while getter phase.

Fields inherited from class org.nuiton.i18n.plugin.parser.impl.AbstractParserXmlMojo

BUFFER_SIZE, documentBuilderFactory, factory, namespaces, rules, userRulesFiles

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

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

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

artifactId, out

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

Method Summary

Modifier and Type	Method	Description
protected String	getCoreRuleFile()
File	getDefaultBasedir()
String[]	getDefaultExcludes()
String[]	getDefaultIncludes()
protected String	getOutGetter()
org.nuiton.io.FileUpdater	newFileUpdater(SourceEntry entry)
protected AbstractParserXmlMojo.XmlFileParser	newXmlFileParser(XPath xpath, DocumentBuilder builder)

Methods inherited from class org.nuiton.i18n.plugin.parser.impl.AbstractParserXmlMojo

getRulefiles, getUserRuleFiles, init, loadRules, loadRulesFile, newFileParser

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

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

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

addGetter, getGetterFile, needGeneration

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

backupFile, checkBundle, checkPackaging, failsIfAnyKeyMissingInBundle, failsIfAnyKeyMissingValue, 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.nuiton.i18n.plugin.parser.I18nParserConfiguration

getLog, isSilent, isVerbose

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

execute, getLog, setLog

Field Details

basedir

@Parameter(property="i18n.xmlBasedir",
           defaultValue="${basedir}/src/main/resources",
           required=true)
protected File basedir

Default directory where to look for files.

Since:

2.0

includes

@Parameter(property="i18n.xmlIncludes",
           required=true)
protected String includes

Defines files to parse.

Since:

2.0

coreRuleFile

@Parameter(property="i18n.coreRuleFiles")
protected String coreRuleFile

Defines an optional files which contain xpath rules to obtain i18n keys in xml files and is defined in plugin.

Since:

2.0

outputGetter

@Parameter(property="i18n.outputGetter",
           defaultValue="xmlUser.getter",
           required=true)
protected String outputGetter

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

Since:

2.0

Constructor Details

ParserXmlUserMojo

public ParserXmlUserMojo()

Method Details

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

getCoreRuleFile

protected String getCoreRuleFile()

Specified by:

getCoreRuleFile in class AbstractParserXmlMojo

newXmlFileParser

protected AbstractParserXmlMojo.XmlFileParser newXmlFileParser(XPath xpath,
 DocumentBuilder builder)

Specified by:

newXmlFileParser in class AbstractParserXmlMojo

getOutGetter

protected String getOutGetter()

Specified by:

getOutGetter in class AbstractI18nParserMojo

Returns:

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

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