Package org.apache.maven.plugins.annotations

Annotation Type Mojo

@Documented @Retention(CLASS) @Target(TYPE) @Inherited public @interface Mojo
This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).
Since:
3.0
Author:
Olivier Lamy

  • Element Details

    • name

      String name
      goal name (required).
      Returns:
      the goal name

    • defaultPhase

      LifecyclePhase defaultPhase
      default phase to bind your mojo.
      Returns:
      the default phase
      Default:
      NONE

    • requiresDependencyResolution

      ResolutionScope requiresDependencyResolution
      the required dependency resolution scope.
      Returns:
      the required dependency resolution scope
      Default:
      NONE

    • requiresDependencyCollection

      ResolutionScope requiresDependencyCollection
      the required dependency collection scope.
      Returns:
      the required dependency collection scope
      Default:
      NONE

    • instantiationStrategy

      InstantiationStrategy instantiationStrategy
      your Mojo instantiation strategy. (Only per-lookup and singleton are supported)
      Returns:
      the instantiation strategy
      Default:
      PER_LOOKUP

    • executionStrategy

      String executionStrategy
      execution strategy: once-per-session or always.
      Returns:
      once-per-session or always
      Default:
      "once-per-session"

    • requiresProject

      boolean requiresProject
      does your mojo requires a project to be executed?
      Returns:
      requires a project
      Default:
      true

    • requiresReports

      boolean requiresReports
      does your mojo requires a reporting context to be executed?
      Returns:
      requires a reporting context
      Default:
      false

    • aggregator

      boolean aggregator
      if the Mojo uses the Maven project and its child modules.
      Returns:
      uses the Maven project and its child modules
      Default:
      false

    • requiresDirectInvocation

      boolean requiresDirectInvocation
      can this Mojo be invoked directly only?
      Returns:
      invoked directly only
      Default:
      false

    • requiresOnline

      boolean requiresOnline
      does this Mojo need to be online to be executed?
      Returns:
      need to be online
      Default:
      false

    • inheritByDefault

      boolean inheritByDefault
      Default:
      true

    • configurator

      String configurator
      own configurator class.
      Returns:
      own configurator class
      Default:
      ""

    • threadSafe

      boolean threadSafe
      is your mojo thread safe (since Maven 3.x)?
      Returns:
      is thread safe
      Default:
      false