org.nuiton.jaxx.plugin

Class GenerateHelpIdsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jaxx.plugin.AbstractJaxxMojo

org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

org.nuiton.jaxx.plugin.GenerateHelpIdsMojo

All Implemented Interfaces:

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

@Mojo(name="generate-help-ids",
      defaultPhase=PROCESS_SOURCES,
      requiresProject=true)
public class GenerateHelpIdsMojo
extends AbstractGenerateHelpMojo

Generate the help ids files from the previous jaxx generation.

Created: 22 déc. 2009

Since:

2.0.0

Author:

Tony Chemit - chemit@codelutin.com

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

AbstractJaxxMojo.JaxxFileUpdater

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 Set<String>	helpIds help ids to react.
static String	INPUT_FILENAME_FORMAT
static String	INPUT_FILENAME_FULL_FORMAT
protected File	inputHelpDirectory Directory where to merge (create) input files.
protected String	inputHelpFilenamePrefix Prefix of input files.
protected boolean	mergeIdsToInput Flag to merge ids into input directory.
protected boolean	strictMode Flag to remove obsolete ids into input files.

Fields inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

generateSearch, locales

Fields inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

generateHelp

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateHelpIdsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkSkip()
protected void	doActionForLocale(Locale locale, boolean isDefaultLocale, File source, String localePath) Do the action for the given locale.
File	getTargetDirectory()
void	init()
protected void	postDoAction() Call back after doing all stuff for all locales declared
protected void	preDoAction() Call back before doing all stuff for all locales declared
void	setTargetDirectory(File targetDirectory)

Methods inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

cleanHelpIdsStore, doAction, getHelpIdsFilename, getHelpIdsStoreFile, getMergeHelpIdsFilename, getMergeHelpIdsStoreFile, getOutputHelpIds, loadHelpIds, removeQuote, setHelpIdsFilename, setMergeHelpIdsFilename, setOutputHelpIds, storeHelpIds

Methods inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

checkPackaging, getEncoding, getLastModified, getProject, isForce, isVerbose, setEncoding, setForce, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkEncoding, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, 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.apache.maven.plugin.Mojo

execute, getLog, setLog

Field Detail

INPUT_FILENAME_FULL_FORMAT

public static final String INPUT_FILENAME_FULL_FORMAT

See Also:

Constant Field Values

INPUT_FILENAME_FORMAT

public static final String INPUT_FILENAME_FORMAT

See Also:

Constant Field Values

mergeIdsToInput

@Parameter(property="jaxx.mergeIdsToInput",
           defaultValue="false",
           required=true)
protected boolean mergeIdsToInput

Flag to merge ids into input directory.

Since:

2.5.12

strictMode

@Parameter(property="jaxx.strictMode",
           defaultValue="false",
           required=true)
protected boolean strictMode

Flag to remove obsolete ids into input files.

Important Note: Be sure to use this after a clean, or using with jaxx.force property to get all ids of any jaxx files detected, otherwise you could loose some data. USE WITH CAUTION.

Note: Only used when mergeIdsToInput parameter is on.

Since:

2.5.12

inputHelpDirectory

@Parameter(property="jaxx.inputHelpDirectory",
           defaultValue="src/main/help",
           required=true)
protected File inputHelpDirectory

Directory where to merge (create) input files.

Note: Only used when mergeIdsToInput parameter is on.

Since:

2.5.12

inputHelpFilenamePrefix

@Parameter(property="jaxx.inputHelpFilenamePrefix",
           defaultValue="helpMapping",
           required=true)
protected String inputHelpFilenamePrefix

Prefix of input files.

Note: -locale.properties will be added to each generated file (example: helpMapping-fr_FR.properties).

Note: Only used when mergeIdsToInput parameter is on.

Since:

2.5.12

helpIds

protected Set<String> helpIds

help ids to react.

Constructor Detail

GenerateHelpIdsMojo

public GenerateHelpIdsMojo()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class AbstractGenerateHelpMojo

Throws:

Exception

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class AbstractGenerateHelpMojo

preDoAction

protected void preDoAction()
                    throws IOException

Description copied from class: AbstractGenerateHelpMojo

Call back before doing all stuff for all locales declared

Specified by:

preDoAction in class AbstractGenerateHelpMojo

Throws:

IOException

doActionForLocale

protected void doActionForLocale(Locale locale,
                     boolean isDefaultLocale,
                     File source,
                     String localePath)
                          throws Exception

Description copied from class: AbstractGenerateHelpMojo

Do the action for the given locale.

Specified by:

doActionForLocale in class AbstractGenerateHelpMojo

Parameters:

locale - the locale to treate

isDefaultLocale - true if given locale is de the default locale

source - where are stored help files for the given locale

localePath - the locale path to use (is default if given locale is default).

Throws:

Exception - if any pb

postDoAction

protected void postDoAction()

Description copied from class: AbstractGenerateHelpMojo

Call back after doing all stuff for all locales declared

Specified by:

postDoAction in class AbstractGenerateHelpMojo

getTargetDirectory

public File getTargetDirectory()

Specified by:

getTargetDirectory in class AbstractJaxxMojo

setTargetDirectory

public void setTargetDirectory(File targetDirectory)

Specified by:

setTargetDirectory in class AbstractJaxxMojo