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 - dev@tchemit.fr

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

Method Summary

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

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.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

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 interface org.apache.maven.plugin.Mojo

execute, getLog, setLog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenerateHelpMojo

public GenerateHelpMojo()

Method Detail

getTargetDirectory

public File getTargetDirectory()

Specified by:

getTargetDirectory in class AbstractJaxxMojo

setTargetDirectory

public void setTargetDirectory(File targetDirectory)

Specified by:

setTargetDirectory in class AbstractJaxxMojo

doAction

public void doAction()

Overrides:

doAction in class AbstractGenerateHelpMojo

preDoAction

protected void preDoAction()

Description copied from class: AbstractGenerateHelpMojo

Call back before doing all stuff for all locales declared

Specified by:

preDoAction in class AbstractGenerateHelpMojo

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

doActionForLocale

protected void doActionForLocale(Locale locale,
                                 boolean isDefaultLocale,
                                 File localizedTarget,
                                 String localePath)

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

localizedTarget - where are stored help files for the given locale

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