Package io.micronaut.starter.feature.database

Class MongoSync

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.database.MongoFeature

io.micronaut.starter.feature.database.MongoSync

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.mongo.sync.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class MongoSync
extends MongoFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

TESTCONTAINERS_GROUP_ID

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MongoSync(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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getCategory()
String	getDescription()
String	getMicronautDocumentation()
String	getName()	The name of the feature.
String	getThirdPartyDocumentation()
String	getTitle()
boolean	supports(ApplicationType applicationType)	This method must be implemented to ensure it is only selectable for the desired application types.

Methods inherited from class io.micronaut.starter.feature.testresources.EaseTestingFeature

processSelectedFeatures

Methods inherited from class java.lang.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 io.micronaut.starter.feature.Feature

getOrder, isCommunity, isPreview, isVisible

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

testContainersDependencies

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MongoSync

public MongoSync(TestContainers testContainers,
 TestResources testResources)

Method Details

getName

public String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

public String getDescription()

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

Parameters:

generatorContext - THe generator context

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.

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

getCategory

public String getCategory()

Returns:

The Category to which the feature belongs to.

getMicronautDocumentation

public 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

public String getThirdPartyDocumentation()

Returns:

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