io.micronaut.starter.feature.messaging.mqtt

Class AbstractMqttFeature

java.lang.Object

io.micronaut.starter.feature.messaging.mqtt.AbstractMqttFeature

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, MessagingFeature, MqttFeature

Direct Known Subclasses:

Mqtt, MqttV3

public abstract class AbstractMqttFeature
extends java.lang.Object
implements MqttFeature

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractMqttFeature()

Method Summary

Modifier and Type	Method and Description
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).
java.lang.String	getDescription()
java.lang.String	getMicronautDocumentation()
boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.starter.feature.messaging.MessagingFeature

getCategory

Methods inherited from interface io.micronaut.starter.feature.Feature

getName, getOrder, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, isVisible, processSelectedFeatures

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

getDescription

Constructor Detail

AbstractMqttFeature

public AbstractMqttFeature()

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

supports

public boolean supports(ApplicationType applicationType)

Description copied from interface: Feature

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.

Specified by:

supports in interface Feature

Specified by:

supports in interface MessagingFeature

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

getMicronautDocumentation

public java.lang.String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

Returns a link to Micronaut documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

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().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context