Package 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:
Tony Chemit - chemit@codelutin.com

  • Field Details

    • INPUT_FILENAME_FULL_FORMAT

      public static final java.lang.String INPUT_FILENAME_FULL_FORMAT
      See Also:
      Constant Field Values

    • INPUT_FILENAME_FORMAT

      public static final java.lang.String INPUT_FILENAME_FORMAT
      See Also:
      Constant Field Values

    • mergeIdsToInput

      @Parameter(property="jaxx.mergeIdsToInput", defaultValue="false", required=true) protected boolean mergeIdsToInput
      Flag to merge ids into input directory.
      Since:
      2.5.12

    • strictMode

      @Parameter(property="jaxx.strictMode", defaultValue="false", required=true) protected boolean strictMode
      Flag to remove obsolete ids into input files. Important Note: Be sure to use this after a clean, or using with jaxx.force property to get all ids of any jaxx files detected, otherwise you could loose some data. USE WITH CAUTION. Note: Only used when mergeIdsToInput parameter is on.
      Since:
      2.5.12

    • inputHelpDirectory

      @Parameter(property="jaxx.inputHelpDirectory", defaultValue="src/main/help", required=true) protected java.io.File inputHelpDirectory
      Directory where to merge (create) input files. Note: Only used when mergeIdsToInput parameter is on.
      Since:
      2.5.12

    • inputHelpFilenamePrefix

      @Parameter(property="jaxx.inputHelpFilenamePrefix", defaultValue="helpMapping", required=true) protected java.lang.String inputHelpFilenamePrefix
      Prefix of input files. Note: -locale.properties will be added to each generated file (example: helpMapping-fr_FR.properties). Note: Only used when mergeIdsToInput parameter is on.
      Since:
      2.5.12

    • helpIds

      protected java.util.Set<java.lang.String> helpIds
      help ids to react.

  • Constructor Details

    • GenerateHelpIdsMojo

      public GenerateHelpIdsMojo()

  • Method Details

    • init

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

    • checkSkip

      protected boolean checkSkip()
      Overrides:
      checkSkip in class AbstractGenerateHelpMojo

    • 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

    • doActionForLocale

      protected void doActionForLocale​(java.util.Locale locale, boolean isDefaultLocale, java.io.File source, 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
      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 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 java.io.File getTargetDirectory()
      Specified by:
      getTargetDirectory in class AbstractJaxxMojo

    • setTargetDirectory

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