Package st.orm.gradle

Class StormExtension

java.lang.Object
st.orm.gradle.StormExtension
public abstract class StormExtension extends Object
Configuration of the Storm Gradle plugin: 

 storm {
     metamodel.set(true)               // generate the compile-time metamodel (default true)
     compilerPlugin.set(true)          // Kotlin only: apply the Storm compiler plugin (default true)
     compilerPluginVariant.set("2.4")  // override the auto-detected Kotlin variant
     javaPreview.set(true)             // Java only: --enable-preview flags (default true)
 }

  • Constructor Summary

    Constructors
    Constructor
    Description
    StormExtension()
    Creates the extension.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<Boolean>
    getCompilerPlugin()
    Whether to add the Storm Kotlin compiler plugin, which makes string interpolations inside SQL template lambdas injection-safe automatically.
    abstract org.gradle.api.provider.Property<String>
    getCompilerPluginVariant()
    Overrides the auto-detected compiler-plugin variant (the Kotlin major.minor suffix, such as "2.4").
    abstract org.gradle.api.provider.Property<Boolean>
    getJavaPreview()
    Whether to add --enable-preview to Java compilation, tests, and execution, required by storm-java21's String Templates on JDK 21.
    abstract org.gradle.api.provider.Property<Boolean>
    getMetamodel()
    Whether to wire the metamodel processor: storm-metamodel-ksp on the ksp configuration for Kotlin projects, storm-metamodel-processor on annotationProcessor for Java projects.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StormExtension

      public StormExtension()
      Creates the extension. Gradle instantiates this type through its object factory.

  • Method Details

    • getMetamodel

      public abstract org.gradle.api.provider.Property<Boolean> getMetamodel()
      Whether to wire the metamodel processor: storm-metamodel-ksp on the ksp configuration for Kotlin projects, storm-metamodel-processor on annotationProcessor for Java projects. Default true.
      Returns:
      whether the metamodel processor is wired.

    • getCompilerPlugin

      public abstract org.gradle.api.provider.Property<Boolean> getCompilerPlugin()
      Whether to add the Storm Kotlin compiler plugin, which makes string interpolations inside SQL template lambdas injection-safe automatically. Kotlin projects only. Default true.
      Returns:
      whether the Kotlin compiler plugin is added.

    • getCompilerPluginVariant

      public abstract org.gradle.api.provider.Property<String> getCompilerPluginVariant()
      Overrides the auto-detected compiler-plugin variant (the Kotlin major.minor suffix, such as "2.4"). Set this when the project uses a Kotlin version newer than the plugin knows about.
      Returns:
      the compiler-plugin variant to use instead of the auto-detected one.

    • getJavaPreview

      public abstract org.gradle.api.provider.Property<Boolean> getJavaPreview()
      Whether to add --enable-preview to Java compilation, tests, and execution, required by storm-java21's String Templates on JDK 21. Java projects only. Default true.
      Returns:
      whether preview features are enabled for Java compilation, tests, and execution.