Package io.micronaut.starter.feature.function

Class AbstractFunctionFeature

java.lang.Object
io.micronaut.starter.feature.function.AbstractFunctionFeature
All Implemented Interfaces:
io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, FunctionFeature, MicronautRuntimeFeature
Direct Known Subclasses:
AbstractAzureFunction, AbstractGoogleCloudFunction, OracleFunction
public abstract class AbstractFunctionFeature extends Object implements FunctionFeature, MicronautRuntimeFeature
Abstract function implementation.
Since:
1.0.0
Author:
graemerocher

  • Constructor Details

    • AbstractFunctionFeature

      public AbstractFunctionFeature()

  • Method Details

    • 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

    • javaControllerTemplate

      protected com.fizzed.rocker.RockerModel javaControllerTemplate(Project project, boolean useSerde)
      Returns the Java function controller template. Subclasses may override to customize the template.
      Parameters:
      project - the project context
      useSerde - whether Serde serialization is enabled
      Returns:
      the Rocker template for the Java controller

    • kotlinControllerTemplate

      protected com.fizzed.rocker.RockerModel kotlinControllerTemplate(Project project, boolean useSerde)
      Returns the Kotlin function controller template. Subclasses may override to customize the template.
      Parameters:
      project - the project context
      useSerde - whether Serde serialization is enabled
      Returns:
      the Rocker template for the Kotlin controller

    • groovyControllerTemplate

      protected com.fizzed.rocker.RockerModel groovyControllerTemplate(Project project, boolean useSerde)
      Returns the Groovy function controller template. Subclasses may override to customize the template.
      Parameters:
      project - the project context
      useSerde - whether Serde serialization is enabled
      Returns:
      the Rocker template for the Groovy controller

    • applyFunction

      protected void applyFunction(GeneratorContext generatorContext, ApplicationType type)
      Applies the function setup based on the application type. Subclasses may override to customize how function templates and dependencies are applied.
      Parameters:
      generatorContext - the generator context
      type - the application type

    • getTestSuffix

      protected String getTestSuffix(ApplicationType type)
      Returns the suffix used for function test class names. Subclasses may override to provide custom suffixes.
      Parameters:
      type - the application type
      Returns:
      the test class name suffix

    • applyTestTemplate

      protected void applyTestTemplate(GeneratorContext generatorContext, Project project, String name)
      Applies the test templates to the module. Subclasses may override to customize the test generation logic.
      Parameters:
      generatorContext - the generator context
      project - the project
      name - the name of the test class

    • readmeTemplate

      protected Optional<com.fizzed.rocker.RockerModel> readmeTemplate(GeneratorContext generatorContext, Project project, BuildTool buildTool)
      Returns the README template for this function feature, if any. Subclasses may override to provide custom documentation.
      Parameters:
      generatorContext - the generator context
      project - the project
      buildTool - the build tool used
      Returns:
      an optional Rocker model for the README

    • getRunCommand

      protected abstract String getRunCommand(BuildTool buildTool)

    • getBuildCommand

      protected abstract String getBuildCommand(BuildTool buildTool)

    • javaJUnitTemplate

      protected abstract com.fizzed.rocker.RockerModel javaJUnitTemplate(Project project)

    • kotlinJUnitTemplate

      protected abstract com.fizzed.rocker.RockerModel kotlinJUnitTemplate(Project project)

    • groovyJUnitTemplate

      protected abstract com.fizzed.rocker.RockerModel groovyJUnitTemplate(Project project)

    • koTestTemplate

      protected abstract com.fizzed.rocker.RockerModel koTestTemplate(Project project)

    • spockTemplate

      public abstract com.fizzed.rocker.RockerModel spockTemplate(Project project)