org.nuiton.i18n.plugin.parser.impl

Class ParserValidationMojo

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

org.nuiton.i18n.plugin.parser.impl.ParserValidationMojo

All Implemented Interfaces:

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

@Mojo(name="parserValidation",
      defaultPhase=GENERATE_RESOURCES)
public class ParserValidationMojo
extends AbstractParserXmlMojo

Find i18n keys from xworks xml validation files.

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

Author:

tchemit

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 and Description
protected String	coreRuleFile Defines the core rules file used to detect i18n keys in xml validation files.
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 String	outputGetter Defines the file name of the getter where to put detected i18n keys while getter phase.
protected boolean	useLocalResolver Always use the local xworks dtd to increase performance.

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

Method Summary

Methods

Modifier and Type	Method and 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.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/resources",
           required=true)
protected File defaultBasedir

Root directory of the default entry.

defaultIncludes

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

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

Note: default value is **\/**-validation.xml

coreRuleFile

@Parameter(property="i18n.coreRuleFile",
           defaultValue="validation.rules",
           required=true)
protected String coreRuleFile

Defines the core rules file used to detect i18n keys in xml validation files.

Note : If you do not want to use it, set it to empty and fill the AbstractParserXmlMojo.userRulesFiles parameter.

Since:

2.0

useLocalResolver

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

Always use the local xworks dtd to increase performance.

Since:

1.6.0

outputGetter

@Parameter(property="i18n.outputGetter",
           defaultValue="validation.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 Detail

ParserValidationMojo

public ParserValidationMojo()

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

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

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