io.micronaut.starter.feature.json

Interface SerializationFeature

All Superinterfaces:

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

All Known Implementing Classes:

SerializationBsonFeature, SerializationJacksonFeature, SerializationJsonpFeature

public interface SerializationFeature
extends JsonFeature

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARTIFACT_ID_MICRONAUT_JACKSON_CORE
static java.lang.String	MICRONAUT_SERIALIZATION

Fields inherited from interface io.micronaut.starter.feature.json.JsonFeature

ARTIFACT_ID_MICRONAUT_JACKSON_DATABIND, DEPENDENCY_MICRONAUT_JACKSON_DATABIND

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default 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).
default java.util.List<Dependency.Builder>	dependencies(GeneratorContext generatorContext)
default java.lang.String	getCategory()
default java.lang.String	getMicronautDocumentation()
java.lang.String	getModule()
default boolean	isPreview()
default Dependency.Builder	micronautRuntimeDependency()
default Dependency.Builder	serdeModule(GeneratorContext generatorContext)
default Dependency.Builder	serdeProcessor()
java.util.List<Substitution>	substitutions(GeneratorContext generatorContext)
default boolean	supports(ApplicationType applicationType) This method must be implemented to ensure it is only selectable for the desired application types.

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

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

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

getDescription

Field Detail

MICRONAUT_SERIALIZATION

static final java.lang.String MICRONAUT_SERIALIZATION

See Also:

Constant Field Values

ARTIFACT_ID_MICRONAUT_JACKSON_CORE

static final java.lang.String ARTIFACT_ID_MICRONAUT_JACKSON_CORE

See Also:

Constant Field Values

Method Detail

isPreview

default boolean isPreview()

Specified by:

isPreview in interface Feature

Returns:

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

getCategory

default java.lang.String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getMicronautDocumentation

default 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

supports

default 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

default 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

dependencies

@NonNull
default java.util.List<Dependency.Builder> dependencies(@NonNull
                                                                 GeneratorContext generatorContext)

micronautRuntimeDependency

@NonNull
default Dependency.Builder micronautRuntimeDependency()

serdeModule

@NonNull
default Dependency.Builder serdeModule(@NonNull
                                                GeneratorContext generatorContext)

serdeProcessor

@NonNull
default Dependency.Builder serdeProcessor()

getModule

java.lang.String getModule()

substitutions

@NonNull
java.util.List<Substitution> substitutions(@NonNull
                                                    GeneratorContext generatorContext)