Package com.onurkat.reclazz.gradle

Class ReclazzExtension

java.lang.Object
com.onurkat.reclazz.gradle.ReclazzExtension
public abstract class ReclazzExtension extends Object
Configuration for the Reclazz Gradle plugin, exposed as the reclazz block.

Everything has a working default, so a Spring Boot project needs only to apply the plugin. Override any of these when the defaults do not fit.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReclazzExtension()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getAgentJar()
    An explicit path to the agent jar.
    abstract org.gradle.api.provider.Property<String>
    getAgentVersion()
    The agent version to resolve as com.onurkat.reclazz:reclazz-agent:<version> when getAgentJar() is not set.
    abstract org.gradle.api.provider.Property<Boolean>
    getApplyToBootRun()
    Attach the agent to the bootRun task when present.
    abstract org.gradle.api.provider.Property<Boolean>
    getApplyToTest()
    Attach the agent to Test tasks.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getArguments()
    Extra agent arguments as key/value pairs, appended as key=value and joined with commas.
    abstract org.gradle.api.provider.Property<Boolean>
    getEnabled()
    Whether the agent is attached at all.
    abstract org.gradle.api.provider.Property<String>
    getPlatform()
    The agent platform, for example spring.
    abstract org.gradle.api.provider.ListProperty<String>
    getWatchDirs()
    Directories the agent watches for recompiled classes.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReclazzExtension

      public ReclazzExtension()

  • Method Details

    • getEnabled

      public abstract org.gradle.api.provider.Property<Boolean> getEnabled()
      Whether the agent is attached at all. Default true.

    • getAgentJar

      public abstract org.gradle.api.file.RegularFileProperty getAgentJar()
      An explicit path to the agent jar. When set, it wins over getAgentVersion() and no dependency is resolved. Use this while the agent is not yet on a registry, or to pin a locally built jar.

    • getAgentVersion

      public abstract org.gradle.api.provider.Property<String> getAgentVersion()
      The agent version to resolve as com.onurkat.reclazz:reclazz-agent:<version> when getAgentJar() is not set. Defaults to the plugin version.

    • getPlatform

      public abstract org.gradle.api.provider.Property<String> getPlatform()
      The agent platform, for example spring. Defaults to spring when the Spring Boot plugin is applied, and is otherwise left to the agent's own default.

    • getWatchDirs

      public abstract org.gradle.api.provider.ListProperty<String> getWatchDirs()
      Directories the agent watches for recompiled classes. Defaults to the main source set output when empty. Multiple entries are joined with a semicolon.

    • getArguments

      public abstract org.gradle.api.provider.MapProperty<String,String> getArguments()
      Extra agent arguments as key/value pairs, appended as key=value and joined with commas. These override the computed platform and watchDirs.

    • getApplyToTest

      public abstract org.gradle.api.provider.Property<Boolean> getApplyToTest()
      Attach the agent to Test tasks. Default true.

    • getApplyToBootRun

      public abstract org.gradle.api.provider.Property<Boolean> getApplyToBootRun()
      Attach the agent to the bootRun task when present. Default true.