Package io.micronaut.starter.feature.view

Class Thymeleaf

java.lang.Object

io.micronaut.starter.feature.view.Thymeleaf

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OneOfFeature, OpenRewriteFeature, MicronautServerDependent, ViewFeature

@Requires(property="micronaut.starter.feature.views.thymeleaf.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Thymeleaf
extends Object
implements ViewFeature, MicronautServerDependent, OpenRewriteFeature

Adds support for server-side view rendering using Thymeleaf.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface io.micronaut.starter.feature.view.ViewFeature

VIEWS_PATH

Constructor Summary

Constructors

Constructor	Description
Thymeleaf()	Deprecated, for removal: This API element is subject to removal in a future version. Use Thymeleaf(io.micronaut.starter.feature.view.ViewsFieldset) instead.
Thymeleaf(ViewsFieldset viewsFieldset)

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	getDescription()
String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()
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.core.naming.Described

getDescription

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

getOrder, isCommunity, isPreview, isVisible

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Methods inherited from interface io.micronaut.starter.feature.view.ViewFeature

getCategory, getFeatureClass, supports

Constructor Details

Thymeleaf

@Inject
public Thymeleaf(ViewsFieldset viewsFieldset)

Thymeleaf

@Deprecated(forRemoval=true,
            since="4.2.0")
public Thymeleaf()

Deprecated, for removal: This API element is subject to removal in a future version.

Use Thymeleaf(io.micronaut.starter.feature.view.ViewsFieldset) instead.

Method Details

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

Parameters:

featureContext - The feature context

getName

public 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

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

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

Specified by:

apply in interface OpenRewriteFeature

Parameters:

generatorContext - THe generator context

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature