Class NullAway

java.lang.Object

io.micronaut.starter.feature.other.NullAway

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.nullaway.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class NullAway
extends Object
implements JvmFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
NullAway(Jspecify jspecify, NullAwayGradlePluginFeature nullAwayGradlePluginFeature, NullAwayMavenPluginFeature nullAwayMavenPluginFeature)

Method Summary

Modifier and Type	Method	Description
String	getCategory()
String	getDescription()
String	getName()	The name of the feature.
String	getThirdPartyDocumentation()
String	getTitle()
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 class Object

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

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

getDescription

Methods inherited from interface Feature

apply, getMicronautDocumentation, getOrder, isCommunity, isPreview, isVisible, supports, supports

Methods inherited from interface JvmFeature

supports, supports, supports

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

NullAway

public NullAway(Jspecify jspecify,
 NullAwayGradlePluginFeature nullAwayGradlePluginFeature,
 NullAwayMavenPluginFeature nullAwayMavenPluginFeature)

Method Details

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

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.

Specified by:

processSelectedFeatures in interface Feature

Parameters:

featureContext - The feature context

getName

public 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

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getThirdPartyDocumentation

@Nullable
public String getThirdPartyDocumentation()

Specified by:

getThirdPartyDocumentation in interface Feature

Returns:

Returns a link to third party. E.g. https://hazelcast.org

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

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.