Package io.micronaut.starter.feature.database

Class DataMongoFeature

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.database.DataMongoFeature

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OneOfFeature, DataDocumentFeature, DataFeature, MongoContributingTestContainerDependency, ContributingTestContainerDependency

Direct Known Subclasses:

DataMongo, DataMongoReactive

public abstract class DataMongoFeature
extends EaseTestingFeature
implements DataDocumentFeature, MongoContributingTestContainerDependency

Base class for our data-mongo features.

Field Summary

Fields inherited from interface io.micronaut.starter.feature.testcontainers.ContributingTestContainerDependency

TESTCONTAINERS_GROUP_ID

Fields inherited from interface io.micronaut.starter.feature.database.DataDocumentFeature

MICRONAUT_DATA_DOCUMENT_PROCESSOR_ARTIFACT

Fields inherited from interface io.micronaut.starter.feature.database.DataFeature

MICRONAUT_DATA_VERSION, SCHEMA_GENERATE_KEY

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataMongoFeature(Data data, TestContainers testContainers, TestResources testResources)

Method Summary

Modifier and Type	Method	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(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getFrameworkDocumentation(GeneratorContext generatorContext)
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
protected abstract @NonNull String	mongoArtifact()
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(io.micronaut.starter.options.Options, java.util.Set).

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.database.DataFeature

getCategory, getDatasourceConfig, getFeatureClass

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

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getDescription, getName, getOrder, getTitle, isCommunity, isPreview, isVisible, supports

Methods inherited from interface io.micronaut.starter.feature.database.MongoContributingTestContainerDependency

testContainersDependencies

Constructor Details

DataMongoFeature

protected DataMongoFeature(Data data,
 TestContainers testContainers,
 TestResources testResources)

Method Details

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

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Specified by:

getFrameworkDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

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

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

Overrides:

processSelectedFeatures in class EaseTestingFeature

Parameters:

featureContext - The feature context

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

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

mongoArtifact

@NonNull
protected abstract @NonNull String mongoArtifact()