Package org.nuiton.jaxx.plugin
Class GenerateHelpMojo
- 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.GenerateHelpMojo
-
- 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", defaultPhase=PROCESS_SOURCES, requiresProject=true, requiresDependencyResolution=COMPILE) @Execute(goal="generate-help-search") public class GenerateHelpMojo extends AbstractGenerateHelpMojo
Mojo to generate all the javax help stuff for your project. This mojo will chain all others help mojo required.- Since:
- 1.3
- Author:
- Tony Chemit - chemit@codelutin.com
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo
AbstractJaxxMojo.JaxxFileUpdater
-
-
Field Summary
-
Fields inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo
generateSearch, locales
-
Fields inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo
generateHelp
-
-
Constructor Summary
Constructors Constructor Description GenerateHelpMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doAction()
protected void
doActionForLocale(Locale locale, boolean isDefaultLocale, File localizedTarget, String localePath)
Do the action for the given locale.File
getTargetDirectory()
protected void
postDoAction()
Call back after doing all stuff for all locales declaredprotected void
preDoAction()
Call back before doing all stuff for all locales declaredvoid
setTargetDirectory(File targetDirectory)
-
Methods inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo
checkSkip, cleanHelpIdsStore, getHelpIdsFilename, getHelpIdsStoreFile, getMergeHelpIdsFilename, getMergeHelpIdsStoreFile, getOutputHelpIds, init, 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
-
-
-
-
Method Detail
-
getTargetDirectory
public File getTargetDirectory()
- Specified by:
getTargetDirectory
in classAbstractJaxxMojo
-
setTargetDirectory
public void setTargetDirectory(File targetDirectory)
- Specified by:
setTargetDirectory
in classAbstractJaxxMojo
-
doAction
public void doAction() throws Exception
- Overrides:
doAction
in classAbstractGenerateHelpMojo
- Throws:
Exception
-
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 classAbstractGenerateHelpMojo
- Throws:
IOException
-
postDoAction
protected void postDoAction()
Description copied from class:AbstractGenerateHelpMojo
Call back after doing all stuff for all locales declared- Specified by:
postDoAction
in classAbstractGenerateHelpMojo
-
doActionForLocale
protected void doActionForLocale(Locale locale, boolean isDefaultLocale, File localizedTarget, String localePath) throws Exception
Description copied from class:AbstractGenerateHelpMojo
Do the action for the given locale.- Specified by:
doActionForLocale
in classAbstractGenerateHelpMojo
- Parameters:
locale
- the locale to treateisDefaultLocale
-true
if given locale is de the default localelocalizedTarget
- where are stored help files for the given localelocalePath
- the locale path to use (isdefault
if given locale is default).- Throws:
Exception
- if any pb
-
-