Package io.micronaut.starter.feature

Interface CommunityFeature

All Superinterfaces:
io.micronaut.core.naming.Described, Feature, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered
All Known Subinterfaces:
AgoraPulseFeature, CamundaCommunityFeature, MicronautCommunityFeature
All Known Implementing Classes:
Buildless, Console, ExternalWorker, GruHttp, JobRunrFeature, Permissions, Platform7, Slack, Worker, Zeebe
public interface CommunityFeature extends Feature
Marker interface for community-contributed features.

Provides helper methods for naming and titling such features, and requires implementation of methods to declare the community contributor and feature name.

Since:
1.0
Author:
Micronaut Community

  • Method Details

    • getName

      @NonNull default @NonNull String getName()
      Description copied from interface: Feature
      The name of the feature. It must be unique.
      Specified by:
      getName in interface Feature
      Specified by:
      getName in interface io.micronaut.core.naming.Named
      Returns:
      the name of the feature

    • getTitle

      @NonNull default @NonNull String getTitle()
      Specified by:
      getTitle in interface Feature
      Returns:
      The title of the feature

    • getCommunityFeatureTitle

      @NonNull @NonNull String getCommunityFeatureTitle()

    • getCommunityFeatureName

      @NonNull @NonNull String getCommunityFeatureName()

    • getCommunityContributor

      @NonNull @NonNull String getCommunityContributor()
      Returns:
      Indicates name of the community contributor.

    • isCommunity

      default boolean isCommunity()
      Specified by:
      isCommunity in interface Feature
      Returns:
      Indicates the feature is a community contribution.