io.micronaut.starter.feature.test

Class Mockk

java.lang.Object

io.micronaut.starter.feature.test.Mockk

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, DefaultFeature, Feature, MockingFeature

@Singleton
public class Mockk
extends java.lang.Object
implements MockingFeature, DefaultFeature

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARTIFACT_ID_MOCKK
static java.lang.String	GROUP_ID_IO_MOCKK
static java.lang.String	NAME_MOCKK

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
Mockk()

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	getName() The name of the feature.
int	getOrder() The order of a feature controls the order in which it applies.
java.lang.String	getThirdPartyDocumentation()
java.lang.String	getTitle()
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.
boolean	shouldApply(ApplicationType applicationType, Options options, java.util.Set<Feature> selectedFeatures) Determines if the feature should be applied to the project.

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.test.MockingFeature

getCategory, supports

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

getMicronautDocumentation, isCommunity, isPreview, processSelectedFeatures

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

getDescription

Field Detail

ARTIFACT_ID_MOCKK

public static final java.lang.String ARTIFACT_ID_MOCKK

See Also:

Constant Field Values

NAME_MOCKK

public static final java.lang.String NAME_MOCKK

See Also:

Constant Field Values

GROUP_ID_IO_MOCKK

public static final java.lang.String GROUP_ID_IO_MOCKK

See Also:

Constant Field Values

Constructor Detail

Mockk

public Mockk()

Method Detail

getName

@NonNull
public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface io.micronaut.core.naming.Named

Specified by:

getName in interface Feature

Returns:

the name of the feature

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public java.lang.String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getThirdPartyDocumentation

public java.lang.String getThirdPartyDocumentation()

Specified by:

getThirdPartyDocumentation in interface Feature

Returns:

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

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

isVisible

public boolean isVisible()

Description copied from interface: Feature

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.

Specified by:

isVisible in interface Feature

Returns:

True if the feature should able to be selected by the user

shouldApply

public boolean shouldApply(ApplicationType applicationType,
                           Options options,
                           java.util.Set<Feature> selectedFeatures)

Description copied from interface: DefaultFeature

Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.

Specified by:

shouldApply in interface DefaultFeature

Parameters:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

getOrder

public int getOrder()

Description copied from interface: Feature

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

Specified by:

getOrder in interface Feature

Returns:

The order of the feature