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:

tchemit

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.

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()
void	doAction()
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
void	setTargetDirectory(File targetDirectory)

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

cleanHelpIdsStore, 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, 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

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

doAction

public void doAction()
              throws Exception

Overrides:

doAction in class AbstractGenerateHelpMojo

Throws:

Exception

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