Package javaposse.jobdsl.dsl

Annotation Interface RequiresPlugin

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface RequiresPlugin
Indicates that a plugin must be installed to use the features provided by the annotated DSL method. A minimum version can be specified as a lower bound for the version of the required plugin.
Since:
1.31

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    id
    The Plugin ID or short name of the required plugin.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    failIfMissing
    Aborts DSL processing when the plugin is not installed or must be updated.
    String
    minimumVersion
    The least acceptable version of the required plugin.

  • Element Details

    • id

      String id
      The Plugin ID or short name of the required plugin.
      Returns:
      the Plugin ID or short name of the required plugin

    • minimumVersion

      String minimumVersion
      The least acceptable version of the required plugin. Optional, any version will be accepted if none is given.
      Returns:
      the least acceptable version of the required plugin or "" if any version will be accepted
      Default:
      ""

    • failIfMissing

      boolean failIfMissing
      Aborts DSL processing when the plugin is not installed or must be updated.
      Returns:
      true if DSL processing should be aborted when the plugin is not installed or must be updated
      Since:
      1.40
      Default:
      false