Package io.micronaut.starter.feature.testresources

Class TestResources

java.lang.Object

io.micronaut.starter.feature.testresources.TestResources

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.test.resources.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class TestResources
extends Object
implements Feature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MICRONAUT_TEST_RESOURCES_ENABLED
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
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	getCategory()
@NonNull String	getDescription()
String	getFrameworkDocumentation(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
@NonNull String	getTitle()

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.projectgen.core.feature.Feature

getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Field Details

MICRONAUT_TEST_RESOURCES_ENABLED

public static final String MICRONAUT_TEST_RESOURCES_ENABLED

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TestResources

public TestResources()

Method Details

getName

@NonNull
public @NonNull 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

@NonNull
public @NonNull String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

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