Package org.openrewrite.gradle

Class RewriteExtension

java.lang.Object
org.openrewrite.gradle.RewriteExtension
public class RewriteExtension extends Object

  • Field Details

    • project

      protected final org.gradle.api.Project project

  • Constructor Details

    • RewriteExtension

      public RewriteExtension(org.gradle.api.Project project)

  • Method Details

    • setConfigFile

      public void setConfigFile(File configFile)

    • setConfigFile

      public void setConfigFile(String configFilePath)

    • setCheckstyleConfigFile

      public void setCheckstyleConfigFile(File configFile)

    • getCheckstyleConfigFile

      @Nullable public File getCheckstyleConfigFile()
      Will prefer to return an explicitly configured checkstyle configuration file location. If none has been specified, will attempt to auto-detect an appropriate file.

    • getCheckstyleProperties

      public Map<String,Object> getCheckstyleProperties()

    • getConfigFileSetDeliberately

      public boolean getConfigFileSetDeliberately()
      Supplying a rewrite configuration file is optional, so if it doesn't exist it isn't an error or a warning. But if the user has deliberately specified a different location from the default, that seems like a reasonable signal that the file should be expected to exist. So this signal can be used to decide if a warning should be displayed if the specified file cannot be found.

    • getConfigFile

      public File getConfigFile()

    • enableRouteMetricsToLog

      public void enableRouteMetricsToLog()

    • isRouteMetricsToLog

      public boolean isRouteMetricsToLog()

    • getMetricsUri

      public String getMetricsUri()

    • setMetricsUri

      public void setMetricsUri(String value)

    • activeRecipe

      public void activeRecipe(String... recipes)

    • clearActiveRecipes

      public void clearActiveRecipes()

    • setActiveRecipes

      public void setActiveRecipes(List<String> activeRecipes)

    • activeStyle

      public void activeStyle(String... styles)

    • clearActiveStyles

      public void clearActiveStyles()

    • setActiveStyles

      public void setActiveStyles(List<String> activeStyles)

    • getActiveStyles

      public List<String> getActiveStyles()

    • getActiveRecipes

      public List<String> getActiveRecipes()

    • getVersionProps

      public Properties getVersionProps()

    • getRewriteVersion

      public String getRewriteVersion()
      Returns the version of rewrite core libraries to be used.

    • getRewritePolyglotVersion

      public String getRewritePolyglotVersion()

    • getRewriteGradleModelVersion

      public String getRewriteGradleModelVersion()

    • getRewriteKotlinVersion

      public String getRewriteKotlinVersion()

    • getCheckstyleToolsVersion

      public String getCheckstyleToolsVersion()

    • setRewriteVersion

      public void setRewriteVersion(String value)

    • getFailOnInvalidActiveRecipes

      public boolean getFailOnInvalidActiveRecipes()

    • setFailOnInvalidActiveRecipes

      public void setFailOnInvalidActiveRecipes(boolean failOnInvalidActiveRecipes)

    • getFailOnDryRunResults

      public boolean getFailOnDryRunResults()

    • setFailOnDryRunResults

      public void setFailOnDryRunResults(boolean failOnDryRunResults)

    • getLogCompilationWarningsAndErrors

      public boolean getLogCompilationWarningsAndErrors()

    • setLogCompilationWarningsAndErrors

      public void setLogCompilationWarningsAndErrors(boolean logCompilationWarningsAndErrors)

    • getCheckstyleConfigProvider

      public javax.inject.Provider<File> getCheckstyleConfigProvider()

    • setCheckstyleConfigProvider

      public void setCheckstyleConfigProvider(javax.inject.Provider<File> checkstyleConfigProvider)

    • getCheckstylePropertiesProvider

      public javax.inject.Provider<Map<String,Object>> getCheckstylePropertiesProvider()

    • setCheckstylePropertiesProvider

      public void setCheckstylePropertiesProvider(javax.inject.Provider<Map<String,Object>> checkstylePropertiesProvider)

    • isEnableExperimentalGradleBuildScriptParsing

      public boolean isEnableExperimentalGradleBuildScriptParsing()

    • setEnableExperimentalGradleBuildScriptParsing

      public void setEnableExperimentalGradleBuildScriptParsing(boolean enableExperimentalGradleBuildScriptParsing)

    • getExclusions

      public List<String> getExclusions()

    • exclusion

      public void exclusion(String... exclusions)

    • exclusion

      public void exclusion(Collection<String> exclusions)

    • getPlainTextMasks

      public List<String> getPlainTextMasks()

    • plainTextMask

      public void plainTextMask(String... masks)

    • plainTextMask

      public void plainTextMask(Collection<String> masks)

    • getSizeThresholdMb

      public int getSizeThresholdMb()

    • setSizeThresholdMb

      public void setSizeThresholdMb(int thresholdMb)

    • getJacksonModuleKotlinVersion

      public String getJacksonModuleKotlinVersion()

    • getThrowOnParseFailures

      public boolean getThrowOnParseFailures()

    • setThrowOnParseFailures

      public void setThrowOnParseFailures(boolean throwOnParseFailures)