Feature (micronaut-starter 3.5.3 API)

All Superinterfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered

All Known Subinterfaces:

AgoraPulseFeature, ApplicationFeature, AwsApiFeature, AwsFeature, AwsLambdaEventFeature, BuildFeature, BuildPluginFeature, CacheFeature, CommunityFeature, ConfigurationFeature, DatabaseDriverConfigurationFeature, DataFeature, DefaultFeature, DiscoveryFeature, DistributedConfigFeature, FunctionFeature, GroovyApplicationFeature, InfrastructureAsCodeFeature, JavaApplicationFeature, JmsFeature, JpaFeature, JsonFeature, KotlinApplicationFeature, LanguageFeature, LanguageSpecificFeature, LoggingFeature, MessagingFeature, MicroStreamFeature, MigrationFeature, MqttFeature, MultiProjectFeature, NovatecFeature, OneOfFeature, PicocliTestFeature, R2dbcFeature, ReactiveFeature, ReloadingFeature, SerializationFeature, ServerFeature, TestFeature, ThirdPartyServerFeature, TracingFeature, ViewFeature

All Known Implementing Classes:

AbstractAzureContainerInstanceWorkflow, AbstractAzureFunction, AbstractCloudRunWorkflow, AbstractDekorateFeature, AbstractDekoratePlatformFeature, AbstractDekorateServiceFeature, AbstractDockerRegistryWorkflow, AbstractFunctionFeature, AbstractGoogleCloudFunction, AbstractJmsFeature, AbstractMicronautServerFeature, AbstractMqttFeature, AbstractOracleFunctionsWorkflow, Acme, ActiveMqArtemis, ActiveMqClassic, AmazonApiGateway, AmazonCognito, AmazonSesEmailFeature, AnnotationApi, AppName, AppOptics, Archaius, Asciidoctor, AssertJ, Atlas, Awaitility, AwsAlexa, AwsLambda, AwsLambdaCustomRuntime, AwsLambdaEventFunctionFeature, AwsLambdaRelatedFeature, AwsLambdaS3EventNotification, AwsLambdaScheduledEvent, AwsParameterStore, AwsSecretsManager, AwsV2Sdk, AzureContainerInstanceGraalWorkflow, AzureContainerInstanceJavaWorkflow, AzureHttpFunction, AzureMonitor, AzureRawFunction, Caffeine, Camunda, CamundaExternalWorker, Cassandra, Cdk, CdkFeature, CloudTrace, CloudWatch, Coherence, CoherenceData, CoherenceDistributedConfiguration, CoherenceFeature, CoherenceGrpcClient, CoherenceSessionStore, Config4k, Console, Consul, Core, Data, DatabaseDriverFeature, DataDog, DataJdbc, DataJpa, DataMongo, DataMongoFeature, DataMongoReactive, DataR2dbc, Dbcp, DekorateHalkyon, DekorateJaeger, DekorateKnative, DekorateKubernetes, DekorateOpenshift, DekoratePrometheus, DekorateServiceCatalog, DiscoveryConsul, DiscoveryKubernetes, DistributedConfigConsul, DockerRegistryWorkflow, DynamoDb, Dynatrace, EHCache, Elastic, Elasticsearch, Eureka, Flyway, Freemarker, Ganglia, GcpFeature, GitHubWorkflowFeature, GoogleCloudFunction, GoogleCloudRawFunction, GoogleCloudRunGraalWorkflow, GoogleCloudRunJavaWorkflow, GoogleSecretManager, GraalVM, GraalVMDockerRegistryWorkflow, Gradle, GradleEnterprise, Graphite, GraphQL, Groovy, GroovyApplication, Grpc, GrpcRandomPort, GruHttp, H2, Hamcrest, Handlebars, Hazelcast, HibernateGorm, HibernateJpa, HibernateValidator, Hikari, HttpClient, HttpSession, Humio, Hystrix, Infinispan, Influx, JacksonDatabindFeature, JacksonXml, Jaeger, JAsyncSQLFeature, Java, JavaApplication, JavamailFeature, JaxRs, JaxRsSecurity, JdbcFeature, JdbiFeature, Jetty, Jib, JmsCore, Jmx, Jmx, Jooq, Jrebel, JTE, Junit, Kafka, KafkaStreams, Kairos, Knative, KoTest, Kotlin, KotlinApplication, KotlinBuildPlugins, KotlinExtensionFunctions, Ktor, Kubernetes, KubernetesClient, KubernetesConfig, KubernetesInformer, KubernetesReactorClient, KubernetesRxJava2Client, LambdaFunctionUrl, Liquibase, Log4j2, Logback, MailjetEmailFeature, Management, MariaDB, Maven, MicrometerFeature, MicronautAot, MicronautBuildPlugin, MicronautGradleEnterprise, MicroStream, MicroStreamCache, MicroStreamRest, Mockito, MongoFeature, MongoGorm, MongoReactive, MongoSync, Mqtt, MqttV3, Multitenancy, MultitenancyGorm, MySQL, Nats, Neo4jBolt, Neo4jGorm, Netty, NewRelic, OpenApi, OpenRewrite, Oracle, OracleAdvancedQueuing, OracleCloud, OracleCloudAutonomousDatabase, OracleCloudSdk, OracleCloudVault, OracleFunction, OracleFunctionsGraalWorkflow, OracleFunctionsJavaWorkflow, OracleRawFunction, Pebble, Picocli, PicocliGroovyApplication, PicocliJavaApplication, PicocliJunit, PicocliKoTest, PicocliKotlinApplication, PicocliSpock, PostgreSQL, PostmarkEmailFeature, ProblemJson, ProjectLombok, Prometheus, Properties, PubSub, R2dbc, RabbitMQ, RandomPort, Reactor, ReactorHttpClient, Readme, RedisLettuce, Ribbon, Rocker, Rss, RssItunes, RxJava1, RxJava2, RxJava2HttpClient, RxJava2HttpServerNetty, RxJava3, RxJava3HttpClient, Security, SecurityAnnotations, SecurityFeature, SecurityJWT, SecurityLdap, SecurityOAuth2, SecurityOAuth2Feature, SecuritySession, SendGridEmailFeature, SerializationBsonFeature, SerializationJacksonFeature, SerializationJsonpFeature, ShadePlugin, Signalfx, SimpleLogging, Soy, Spock, Spring, SpringBoot, SpringDataJdbc, SpringDataJpa, SpringFeature, Springloaded, SpringWeb, SQLServer, SQS, Stackdriver, Statsd, SwaggerUI, TemplateEmailFeature, TestContainers, TestContainersFeature, Thymeleaf, Tomcat, Tomcat, Toml, Ucp, Undertow, Velocity, VertxMySql, VertxPg, Wavefront, Worker, Yaml, Zeebe, Zipkin
```
@Indexed(value=Feature.class)
public interface Feature
extends io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.naming.Described
```
A feature is a class that affects the outcome of a generated project.

Since:

2.0.0

Author:

James Kleeh

Field Summary
- Fields inherited from interface io.micronaut.core.order.Ordered
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`apply(GeneratorContext generatorContext)` If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of `DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set)`, or added explicitly by another feature through `FeatureContext.addFeature(Feature)`.
`default java.lang.String`	`getCategory()`
`default java.lang.String`	`getDescription()`
`default java.lang.String`	`getMicronautDocumentation()`
`java.lang.String`	`getName()` The name of the feature.
`default int`	`getOrder()` The order of a feature controls the order in which it applies.
`default java.lang.String`	`getThirdPartyDocumentation()`
`default java.lang.String`	`getTitle()`
`default boolean`	`isCommunity()`
`default boolean`	`isPreview()`
`default boolean`	`isVisible()` Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
`default void`	`processSelectedFeatures(FeatureContext featureContext)` If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of `DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set)`.
`boolean`	`supports(ApplicationType applicationType)` This method must be implemented to ensure it is only selectable for the desired application types.

Methods inherited from interface io.micronaut.core.naming.Described
getDescription

- Method Detail
  - getName
```
@NonNull
java.lang.String getName()
```
    The name of the feature. It must be unique.
    
    Specified by:
    
    getName in interface io.micronaut.core.naming.Named
    
    Returns:
    
    the name of the feature
  - isPreview
```
default boolean isPreview()
```
    Returns:
    
    Indicates the feature is in preview status and is subject to change.
  - isCommunity
```
default boolean isCommunity()
```
    Returns:
    
    Indicates the feature is a community contribution.
  - getTitle
```
default java.lang.String getTitle()
```
    Returns:
    
    The title of the feature
  - getDescription
```
default java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface io.micronaut.core.naming.Described
  - getOrder
```
default int getOrder()
```
    The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.
    
    Specified by:
    
    getOrder in interface io.micronaut.core.order.Ordered
    
    Returns:
    
    The order of the feature
  - processSelectedFeatures
```
default void processSelectedFeatures(FeatureContext featureContext)
```
    If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.
    
    Parameters:
    
    featureContext - The feature context
  - apply
```
default void apply(GeneratorContext generatorContext)
```
    If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().
    
    Parameters:
    
    generatorContext - THe generator context
  - supports
```
boolean supports(ApplicationType applicationType)
```
    This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.
    
    Parameters:
    
    applicationType - The application type
    
    Returns:
    
    True if the feature can be selected by the user
  - isVisible
```
default boolean isVisible()
```
    Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
    
    Returns:
    
    True if the feature should able to be selected by the user
  - getCategory
```
default java.lang.String getCategory()
```
    Returns:
    
    The Category to which the feature belongs to.
  - getMicronautDocumentation
```
@Nullable
default java.lang.String getMicronautDocumentation()
```
    Returns:
    
    Returns a link to Micronaut documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast
  - getThirdPartyDocumentation
```
@Nullable
default java.lang.String getThirdPartyDocumentation()
```
    Returns:
    
    Returns a link to third party. E.g. https://hazelcast.org

Interface Feature

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

Method Summary

Methods inherited from interface io.micronaut.core.naming.Described

Method Detail

getName

isPreview

isCommunity

getTitle

getDescription

getOrder

processSelectedFeatures

apply

supports

isVisible

getCategory

getMicronautDocumentation

getThirdPartyDocumentation