Module io.helidon.common.features.api
Package io.helidon.common.features.api

Annotation Interface Feature

@Target(MODULE) @Retention(SOURCE) public @interface Feature
A Helidon feature annotation to be placed on module in module-info.java.

This feature descriptor can be augmented with additioonal annotations:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of this feature, to be displayed when details are printed during startup.
    String
    value
    Name of this feature.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    HelidonFlavor[]
    in
    Which flavors will this feature be printed in.
    HelidonFlavor[]
    invalidIn
    Flavors not supported by this feature - e.g.
    String[]
    path
    Path of this feature (a feature path).
    String
    since
    What is the first version that has seen this feature.

  • Element Details

    • value

      String value
      Name of this feature.
      Returns:
      name

    • since

      String since
      What is the first version that has seen this feature.
      Returns:
      version of Helidon this feature was introduced in
      Default:
      "1.0.0"

    • path

      String[] path
      Path of this feature (a feature path). If this is a top level feature, it can be omitted and the value() would be used instead.
      Returns:
      feature path
      Default:
      {}

    • description

      String description
      Description of this feature, to be displayed when details are printed during startup. Should be reasonably short
      Returns:
      description

    • in

      HelidonFlavor[] in
      Which flavors will this feature be printed in.
      Returns:
      flavors to print this feature, leave empty for any flavor.
      Default:
      {}

    • invalidIn

      HelidonFlavor[] invalidIn
      Flavors not supported by this feature - e.g. the set up is invalid, if this feature is added to classpath of this flavor.
      Returns:
      flavors that are not compatible with this feature
      Default:
      {}