Package org.processmining.framework.plugin.annotations

Annotation Interface PluginVariant

@Retention(RUNTIME) @Target(METHOD) public @interface PluginVariant

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int[]
    requiredParameterLabels
    Each plugin variant specifies the required parameter labels in this Array.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    help
    Returns the help / description for this plugin variant.
    String
    variantLabel
    This String represents the label of the plugin variant.

  • Element Details

    • requiredParameterLabels

      int[] requiredParameterLabels
      Each plugin variant specifies the required parameter labels in this Array. The array should be at most as long as the parameterLabels array of the Plugin annotation. Furthermore, all elements of the array should be indices in the parametersLabels array of the Plugin annotation and the elements should be ordered.
      Returns:

    • variantLabel

      String variantLabel
      This String represents the label of the plugin variant. This label is used to identify different variants of the same plugin, specifically when multiple variants accept the same parameters of the same types.
      Default:
      ""

    • help

      String help
      Returns the help / description for this plugin variant.
      Returns:
      Empty string as default
      Default:
      ""