io.micronaut.starter.feature.dekorate

Class AbstractDekorateFeature

java.lang.Object

io.micronaut.starter.feature.dekorate.AbstractDekorateFeature

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDekoratePlatformFeature, AbstractDekorateServiceFeature

public abstract class AbstractDekorateFeature
extends java.lang.Object
implements Feature

Abstract implementation of Dekorate feature.

Since:

2.0

Author:

Pavol Gressa

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractDekorateFeature()

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	getCategory()
java.lang.String	getMicronautDocumentation()
boolean	isPreview()
boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

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

getDescription, getName, getOrder, getThirdPartyDocumentation, getTitle, isVisible, processSelectedFeatures

Constructor Detail

AbstractDekorateFeature

public AbstractDekorateFeature()

Method Detail

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

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

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

isPreview

public boolean isPreview()

Specified by:

isPreview in interface Feature

Returns:

Indicates the feature is in preview status and is subject to change.

getMicronautDocumentation

@Nullable
public java.lang.String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

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