Interface GoalRef

public interface GoalRef
Compile-time identifier for a goal exported by an IKE Maven plugin.

Each plugin provides an enum implementing this interface — e.g. network.ike.plugin.IkeGoal for ike-maven-plugin (prefix ike:), network.ike.pipeline.plugin.doc.IdocGoal for ike-doc-maven-plugin (prefix idoc:). Callers that invoke goals from Java — for report identification, javadoc examples that survive a rename, or subprocess exec — reference enum values rather than string literals, so the compiler catches every goal rename the moment it happens.

The qualified() default implementation combines pluginPrefix() and goalName() with a single colon, matching Maven's prefix:goal invocation syntax.

See ike-issues #215 for the split that introduced this interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    One-line human description of what this goal does.
    String
    goalName()
    The bare goal name as it appears in the mojo's @Mojo(name = ...) annotation, e.g.
    String
    pluginPrefix()
    The plugin prefix, e.g.
    default String
    qualified()
    The fully-qualified goal invocation, e.g.

  • Method Details

    • pluginPrefix

      String pluginPrefix()
      The plugin prefix, e.g. "ike" for ike-maven-plugin or "idoc" for ike-doc-maven-plugin. Every enum value for a single plugin returns the same prefix.
      Returns:
      the plugin prefix without a trailing colon

    • goalName

      String goalName()
      The bare goal name as it appears in the mojo's @Mojo(name = ...) annotation, e.g. "release-publish", "asciidoc".
      Returns:
      the bare goal name

    • qualified

      default String qualified()
      The fully-qualified goal invocation, e.g. "ike:release-publish" or "idoc:asciidoc".
      Returns:
      pluginPrefix() + ":" + goalName()

    • description

      String description()
      One-line human description of what this goal does. Used in help goal output and per-goal report headers.
      Returns:
      the human description