Package org.nuiton.jaxx.plugin

Class GenerateHelpSearchMojo

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.GenerateHelpSearchMojo
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-search",
      defaultPhase=PROCESS_SOURCES,
      requiresProject=true,
      requiresDependencyResolution=COMPILE)
@Execute(goal="generate-help-files")
public class GenerateHelpSearchMojo
extends AbstractGenerateHelpMojo
Generate the javax search index help for your project. The current files should be generated always in a generated directory and not in your src directories (this is mainly binary files not to be stored in scm system)...
Since:
2.0.0
Author:
Tony Chemit - chemit@codelutin.com

  • Field Details

    • outputHelpSearch

      @Parameter(property="jaxx.outputHelpSearch", defaultValue="${project.basedir}/target/generated-sources/help", required=true) protected java.io.File outputHelpSearch
      The directory where to create or update help search index files.
      Since:
      2.0.0

    • inputHelp

      @Parameter(property="jaxx.inputHelp", defaultValue="${project.basedir}/src/main/help", required=true) protected java.io.File inputHelp
      The directory where to pick content files to generate the index.
      Since:
      2.0.0

    • timestamp

      protected java.lang.String timestamp

  • Constructor Details

    • GenerateHelpSearchMojo

      public GenerateHelpSearchMojo()

  • Method Details

    • init

      public void init() throws java.lang.Exception
      Overrides:
      init in class AbstractGenerateHelpMojo
      Throws:
      java.lang.Exception

    • getTargetDirectory

      public java.io.File getTargetDirectory()
      Specified by:
      getTargetDirectory in class AbstractJaxxMojo

    • setTargetDirectory

      public void setTargetDirectory​(java.io.File targetDirectory)
      Specified by:
      setTargetDirectory in class AbstractJaxxMojo

    • checkSkip

      protected boolean checkSkip()
      Overrides:
      checkSkip in class AbstractGenerateHelpMojo

    • doActionForLocale

      protected void doActionForLocale​(java.util.Locale locale, boolean isDefaultLocale, java.io.File localizedTarget, java.lang.String localePath) throws java.lang.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
      localizedTarget - 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

    • preDoAction

      protected void preDoAction() throws java.io.IOException
      Description copied from class: AbstractGenerateHelpMojo
      Call back before doing all stuff for all locales declared
      Specified by:
      preDoAction in class AbstractGenerateHelpMojo
      Throws:
      java.io.IOException

    • 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

    • generateSearchIndex

      protected void generateSearchIndex​(java.io.File source, java.io.File target, java.util.Locale locale) throws java.lang.Exception
      Throws:
      java.lang.Exception