Enum Class IdocGoal

java.lang.Object
java.lang.Enum<IdocGoal>
network.ike.docs.plugin.IdocGoal
All Implemented Interfaces:
Serializable, Comparable<IdocGoal>, Constable, network.ike.plugin.support.GoalRef
public enum IdocGoal extends Enum<IdocGoal> implements network.ike.plugin.support.GoalRef
Compile-time identity for every idoc:* goal in this plugin. Each value wraps the bare goal name, the mojo class that implements it, and a short human description.

Parallels network.ike.plugin.IkeGoal (ike-maven-plugin) and network.ike.plugin.ws.WsGoal (ike-workspace-maven-plugin). All three implement GoalRef so a shared GoalReport writer can address goals across plugins without stringly-typed coupling.

Introduced by ike-issues #215, which split the asciidoc/render mojos out of ike-maven-plugin to dissolve the reverse-dep cycle on koncept-asciidoc-extension.

  • Enum Constant Details

    • ADOCSTUDIO

      public static final IdocGoal ADOCSTUDIO
      idoc:adocstudio — edit the project in AsciiDocFX.

    • ASCIIDOC

      public static final IdocGoal ASCIIDOC
      idoc:asciidoc — render AsciiDoc to HTML, DocBook, and Prawn PDF.

    • COPY_DEFAULT_PDF

      public static final IdocGoal COPY_DEFAULT_PDF
      idoc:copy-default-pdf — copy the default-renderer PDF to the site.

    • COPY_DOCS

      public static final IdocGoal COPY_DOCS
      idoc:copy-docs — copy rendered docs into the site.

    • FIX_SVG

      public static final IdocGoal FIX_SVG
      idoc:fix-svg — post-process SVGs for PDF renderer compatibility.

    • INJECT_BREADCRUMB

      public static final IdocGoal INJECT_BREADCRUMB
      idoc:inject-breadcrumb — inject breadcrumbs into rendered HTML.

    • LINT_SITE

      public static final IdocGoal LINT_SITE
      idoc:lint-site — lint src/site/site.xml for IKE theme/breadcrumb drift (#319).

    • PACKAGE_DOC

      public static final IdocGoal PACKAGE_DOC
      idoc:package-doc — package rendered docs as an ike-doc artifact.

    • PATCH_DOCBOOK

      public static final IdocGoal PATCH_DOCBOOK
      idoc:patch-docbook — apply local patches to DocBook XSL output.

    • PREPARE_RENDERER_OUTPUT

      public static final IdocGoal PREPARE_RENDERER_OUTPUT
      idoc:prepare-renderer-output — prepare per-renderer output dirs.

    • RENDER_PDF

      public static final IdocGoal RENDER_PDF
      idoc:render-pdf — render AsciiDoc to PDF via a configured renderer.

    • SCAN_LOGS

      public static final IdocGoal SCAN_LOGS
      idoc:scan-logs — scan renderer logs for warnings and errors.

  • Field Details

    • PLUGIN_PREFIX

      public static final String PLUGIN_PREFIX
      Shared idoc: prefix for all goals in this plugin.
      See Also:

  • Method Details

    • values

      public static IdocGoal[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static IdocGoal valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • goalName

      public String goalName()
      The bare goal name as it appears in @Mojo(name = ...).
      Specified by:
      goalName in interface network.ike.plugin.support.GoalRef
      Returns:
      the bare goal name

    • pluginPrefix

      public String pluginPrefix()
      The idoc plugin prefix — shared by every goal in this enum.
      Specified by:
      pluginPrefix in interface network.ike.plugin.support.GoalRef
      Returns:
      PLUGIN_PREFIX

    • qualified

      public String qualified()
      The fully-qualified goal invocation, e.g. "idoc:render-pdf".
      Specified by:
      qualified in interface network.ike.plugin.support.GoalRef
      Returns:
      the fully-qualified goal invocation

    • mojoClass

      public Class<? extends org.apache.maven.api.plugin.Mojo> mojoClass()
      The mojo class that implements this goal.
      Returns:
      the mojo class

    • description

      public String description()
      One-line human description of what this goal does.
      Specified by:
      description in interface network.ike.plugin.support.GoalRef
      Returns:
      the human description

    • byName

      public static Optional<IdocGoal> byName(String goalName)
      Look up a goal by its bare name (e.g. "render-pdf").
      Parameters:
      goalName - the bare goal name, without the idoc: prefix
      Returns:
      the matching goal, or empty if none