Package org.nuiton.jaxx.plugin

Class AbstractGenerateHelpMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.nuiton.plugin.AbstractPlugin
org.nuiton.jaxx.plugin.AbstractJaxxMojo
org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.plugin.Plugin, org.nuiton.plugin.PluginWithEncoding
Direct Known Subclasses:
GenerateHelpFilesMojo, GenerateHelpIdsMojo, GenerateHelpMojo, GenerateHelpSearchMojo
public abstract class AbstractGenerateHelpMojo
extends AbstractJaxxMojo
Abstract Mojo to generate help stuff.
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 Description
    protected boolean generateSearch
    Flag to generate the search index.
    protected java.lang.String locales
    The locales to generate for help, separeted by comma.

    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
    AbstractGenerateHelpMojo()  

  • Method Summary

    Modifier and Type Method Description
    protected boolean checkSkip()  
    protected void cleanHelpIdsStore()  
    protected void doAction()  
    protected abstract void doActionForLocale​(java.util.Locale locale, boolean isDefaultLocale, java.io.File source, java.lang.String localePath)
    Do the action for the given locale.
    java.lang.String getHelpIdsFilename()  
    java.io.File getHelpIdsStoreFile()  
    java.lang.String getMergeHelpIdsFilename()  
    java.io.File getMergeHelpIdsStoreFile()  
    java.io.File getOutputHelpIds()  
    protected void init()  
    protected java.util.Set<java.lang.String> loadHelpIds​(java.io.File file)  
    protected abstract void postDoAction()
    Call back after doing all stuff for all locales declared
    protected abstract void preDoAction()
    Call back before doing all stuff for all locales declared
    protected java.lang.String removeQuote​(java.lang.String txt)  
    void setHelpIdsFilename​(java.lang.String helpIdsFilename)  
    void setMergeHelpIdsFilename​(java.lang.String mergeHelpIdsFilename)  
    void setOutputHelpIds​(java.io.File outputHelpIds)  
    protected void storeHelpIds​(java.io.File file, java.util.Set<java.lang.String> ids)  

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

    checkPackaging, getEncoding, getLastModified, getProject, getTargetDirectory, isForce, isVerbose, setEncoding, setForce, setProject, setTargetDirectory, 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 Details

    • locales

      @Parameter(property="jaxx.locales", required=true) protected java.lang.String locales
      The locales to generate for help, separeted by comma. The first locale given is the default locale.
      Since:
      2.0.0

    • generateSearch

      @Parameter(property="jaxx.generateSearch", defaultValue="true", required=true) protected boolean generateSearch
      Flag to generate the search index.
      Since:
      1.3

  • Constructor Details

    • AbstractGenerateHelpMojo

      public AbstractGenerateHelpMojo()

  • Method Details

    • doActionForLocale

      protected abstract void doActionForLocale​(java.util.Locale locale, boolean isDefaultLocale, java.io.File source, java.lang.String localePath) throws java.lang.Exception
      Do the action for the given locale.
      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:
      java.lang.Exception - if any pb

    • postDoAction

      protected abstract void postDoAction()
      Call back after doing all stuff for all locales declared

    • preDoAction

      protected abstract void preDoAction() throws java.io.IOException
      Call back before doing all stuff for all locales declared
      Throws:
      java.io.IOException

    • init

      protected void init() throws java.lang.Exception
      Specified by:
      init in class org.nuiton.plugin.AbstractPlugin
      Throws:
      java.lang.Exception

    • checkSkip

      protected boolean checkSkip()
      Overrides:
      checkSkip in class org.nuiton.plugin.AbstractPlugin

    • doAction

      protected void doAction() throws java.lang.Exception
      Specified by:
      doAction in class org.nuiton.plugin.AbstractPlugin
      Throws:
      java.lang.Exception

    • getOutputHelpIds

      public java.io.File getOutputHelpIds()

    • setOutputHelpIds

      public void setOutputHelpIds​(java.io.File outputHelpIds)

    • getHelpIdsStoreFile

      public java.io.File getHelpIdsStoreFile()

    • getMergeHelpIdsStoreFile

      public java.io.File getMergeHelpIdsStoreFile()

    • getHelpIdsFilename

      public java.lang.String getHelpIdsFilename()

    • setHelpIdsFilename

      public void setHelpIdsFilename​(java.lang.String helpIdsFilename)

    • getMergeHelpIdsFilename

      public java.lang.String getMergeHelpIdsFilename()

    • setMergeHelpIdsFilename

      public void setMergeHelpIdsFilename​(java.lang.String mergeHelpIdsFilename)

    • cleanHelpIdsStore

      protected void cleanHelpIdsStore() throws java.io.IOException
      Throws:
      java.io.IOException

    • loadHelpIds

      protected java.util.Set<java.lang.String> loadHelpIds​(java.io.File file) throws java.io.IOException
      Throws:
      java.io.IOException

    • storeHelpIds

      protected void storeHelpIds​(java.io.File file, java.util.Set<java.lang.String> ids) throws java.io.IOException
      Throws:
      java.io.IOException

    • removeQuote

      protected java.lang.String removeQuote​(java.lang.String txt)