Interface ConfigurationValidationScenario

All Known Implementing Classes:
DefaultConfigurationValidationScenario
public interface ConfigurationValidationScenario
Per-scenario configuration for Micronaut configuration validation.
Since:
5.0.0

  • Method Details

    • getEnabled

      org.gradle.api.provider.Property<Boolean> getEnabled()
      Enables or disables this scenario.
      Returns:
      enabled flag

    • getEnvironments

      org.gradle.api.provider.ListProperty<String> getEnvironments()
      Enabled Micronaut environments.

      Values map to --env (repeatable).

      Returns:
      environments

    • getFailOnNotPresent

      org.gradle.api.provider.Property<Boolean> getFailOnNotPresent()
      Whether unknown configuration properties should be considered errors.

      Maps to --fail-on-not-present.

      Returns:
      fail-on-not-present flag

    • getDeduceEnvironments

      org.gradle.api.provider.Property<Boolean> getDeduceEnvironments()
      Whether Micronaut environments should be deduced.

      Maps to --deduce-environments.

      Returns:
      deduce-environments flag

    • getFormat

      org.gradle.api.provider.Property<String> getFormat()
      Report format.

      Valid values are json, html, and both. Maps to --format.

      Returns:
      report format

    • getSuppressions

      org.gradle.api.provider.ListProperty<String> getSuppressions()
      Suppression patterns.

      Each pattern maps to --suppress.

      Returns:
      suppression patterns

    • getSuppressedInjectionErrors

      org.gradle.api.provider.ListProperty<String> getSuppressedInjectionErrors()
      Dependency injection suppression patterns.

      Patterns are appended to global patterns declared via ConfigurationValidationExtension.getSuppressedInjectionErrors().

      Returns:
      dependency injection suppression patterns

    • getOutputDirectory

      org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Scenario output directory.
      Returns:
      output directory

    • getOverrideClasspath

      org.gradle.api.provider.Property<Boolean> getOverrideClasspath()
      When true, the scenario classpath fully replaces the default classpath computed by the plugin.
      Returns:
      override classpath flag

    • getClasspath

      org.gradle.api.file.ConfigurableFileCollection getClasspath()
      Extra or overridden classpath entries used to validate configuration.

      This classpath is passed to the validator CLI via --classpath.

      Returns:
      classpath entries

    • getResourcesDirs

      org.gradle.api.provider.ListProperty<String> getResourcesDirs()
      Resource directories under ConfigurationValidationExtension.getProjectBaseDir().

      Used for origin rewriting in console output. Values map to --resources-dirs.

      Returns:
      resource directory paths (relative to project base dir)