Class DefaultConfigurationValidationExtension

java.lang.Object

io.micronaut.gradle.configuration.validation.DefaultConfigurationValidationExtension

All Implemented Interfaces:

ConfigurationValidationExtension

public abstract class DefaultConfigurationValidationExtension
extends Object
implements ConfigurationValidationExtension

Default implementation of ConfigurationValidationExtension.

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurationValidationExtension(org.gradle.api.Project project)	Creates the extension and initializes scenario defaults.

Method Summary

Modifier and Type	Method	Description
final void	assemble(org.gradle.api.Action<? super ConfigurationValidationScenario> action)	Configure the assemble (production) validation scenario.
abstract org.gradle.api.provider.Property<Boolean>	getDeduceEnvironments()	Whether Micronaut environments should be deduced.
abstract org.gradle.api.provider.Property<Boolean>	getEnabled()	Enables or disables configuration validation globally.
abstract org.gradle.api.provider.Property<Boolean>	getFailOnNotPresent()	Whether unknown configuration properties should be considered errors.
abstract org.gradle.api.provider.Property<String>	getFormat()	Report format.
abstract org.gradle.api.provider.Property<String>	getJavaExecutable()	Optional explicit Java executable path used to execute the validator CLI.
abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher>	getJavaLauncher()	Optional Java launcher used to execute the validator CLI.
abstract org.gradle.api.file.DirectoryProperty	getOutputDirectory()	Base output directory for generated validation reports.
final ConfigurationValidationScenario	getProduction()	Scenario used for packaging/build validation.
abstract org.gradle.api.file.DirectoryProperty	getProjectBaseDir()	Project base directory used for origin path rewriting in console output.
final ConfigurationValidationScenario	getRun()	Scenario used for run.
abstract org.gradle.api.provider.ListProperty<String>	getSuppressedInjectionErrors()	Dependency injection suppression patterns.
abstract org.gradle.api.provider.ListProperty<String>	getSuppressions()	Suppression patterns.
final ConfigurationValidationScenario	getTest()	Scenario used for test.
abstract org.gradle.api.provider.Property<Boolean>	getValidateDependencyInjection()	Whether dependency injection should be validated.
abstract org.gradle.api.provider.Property<String>	getVersion()	Version of micronaut-json-schema-configuration-validator used by the validation tasks.
final void	run(org.gradle.api.Action<? super ConfigurationValidationScenario> action)	Configure the run validation scenario.
final void	test(org.gradle.api.Action<? super ConfigurationValidationScenario> action)	Configure the test validation scenario.

Methods inherited from class Object

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

Constructor Details

DefaultConfigurationValidationExtension

@Inject
public DefaultConfigurationValidationExtension(org.gradle.api.Project project)

Creates the extension and initializes scenario defaults.

Parameters:

project - the owning project

Method Details

getVersion

public abstract org.gradle.api.provider.Property<String> getVersion()

Description copied from interface: ConfigurationValidationExtension

Version of micronaut-json-schema-configuration-validator used by the validation tasks.

Specified by:

getVersion in interface ConfigurationValidationExtension

Returns:

the validator version

getEnabled

public abstract org.gradle.api.provider.Property<Boolean> getEnabled()

Description copied from interface: ConfigurationValidationExtension

Enables or disables configuration validation globally.

Specified by:

getEnabled in interface ConfigurationValidationExtension

Returns:

global enabled flag

getOutputDirectory

public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()

Description copied from interface: ConfigurationValidationExtension

Base output directory for generated validation reports.

Scenario tasks will write into a scenario subdirectory.

Specified by:

getOutputDirectory in interface ConfigurationValidationExtension

Returns:

the base output directory

getFailOnNotPresent

public abstract org.gradle.api.provider.Property<Boolean> getFailOnNotPresent()

Description copied from interface: ConfigurationValidationExtension

Whether unknown configuration properties should be considered errors.

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

Specified by:

getFailOnNotPresent in interface ConfigurationValidationExtension

Returns:

fail-on-not-present flag

getDeduceEnvironments

public abstract org.gradle.api.provider.Property<Boolean> getDeduceEnvironments()

Description copied from interface: ConfigurationValidationExtension

Whether Micronaut environments should be deduced.

Maps to --deduce-environments.

Specified by:

getDeduceEnvironments in interface ConfigurationValidationExtension

Returns:

deduce-environments flag

getValidateDependencyInjection

public abstract org.gradle.api.provider.Property<Boolean> getValidateDependencyInjection()

Description copied from interface: ConfigurationValidationExtension

Whether dependency injection should be validated.

Maps to --validate-dependency-injection.

Specified by:

getValidateDependencyInjection in interface ConfigurationValidationExtension

Returns:

validate-dependency-injection flag

getFormat

public abstract org.gradle.api.provider.Property<String> getFormat()

Description copied from interface: ConfigurationValidationExtension

Report format.

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

Specified by:

getFormat in interface ConfigurationValidationExtension

Returns:

report format

getSuppressions

public abstract org.gradle.api.provider.ListProperty<String> getSuppressions()

Description copied from interface: ConfigurationValidationExtension

Suppression patterns.

Each pattern maps to --suppress.

Specified by:

getSuppressions in interface ConfigurationValidationExtension

Returns:

suppression patterns

getSuppressedInjectionErrors

public abstract org.gradle.api.provider.ListProperty<String> getSuppressedInjectionErrors()

Description copied from interface: ConfigurationValidationExtension

Dependency injection suppression patterns.

Each pattern is a fully qualified class name or *-wildcard pattern, passed to the validator CLI via --suppress-inject-errors <csv>.

Specified by:

getSuppressedInjectionErrors in interface ConfigurationValidationExtension

Returns:

dependency injection suppression patterns

getProjectBaseDir

public abstract org.gradle.api.file.DirectoryProperty getProjectBaseDir()

Description copied from interface: ConfigurationValidationExtension

Project base directory used for origin path rewriting in console output.

Maps to --project-base-dir.

Specified by:

getProjectBaseDir in interface ConfigurationValidationExtension

Returns:

project base directory

getJavaLauncher

public abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher> getJavaLauncher()

Description copied from interface: ConfigurationValidationExtension

Optional Java launcher used to execute the validator CLI.

Specified by:

getJavaLauncher in interface ConfigurationValidationExtension

Returns:

Java launcher

getJavaExecutable

public abstract org.gradle.api.provider.Property<String> getJavaExecutable()

Description copied from interface: ConfigurationValidationExtension

Optional explicit Java executable path used to execute the validator CLI.

Specified by:

getJavaExecutable in interface ConfigurationValidationExtension

Returns:

Java executable

getRun

public final ConfigurationValidationScenario getRun()

Description copied from interface: ConfigurationValidationExtension

Scenario used for run.

Specified by:

getRun in interface ConfigurationValidationExtension

Returns:

run scenario configuration

run

public final void run(org.gradle.api.Action<? super ConfigurationValidationScenario> action)

Configure the run validation scenario.

Parameters:

action - configuration action

getTest

public final ConfigurationValidationScenario getTest()

Description copied from interface: ConfigurationValidationExtension

Scenario used for test.

Specified by:

getTest in interface ConfigurationValidationExtension

Returns:

test scenario configuration

test

public final void test(org.gradle.api.Action<? super ConfigurationValidationScenario> action)

Configure the test validation scenario.

Parameters:

action - configuration action

getProduction

public final ConfigurationValidationScenario getProduction()

Description copied from interface: ConfigurationValidationExtension

Scenario used for packaging/build validation.

Specified by:

getProduction in interface ConfigurationValidationExtension

Returns:

production scenario configuration

assemble

public final void assemble(org.gradle.api.Action<? super ConfigurationValidationScenario> action)

Configure the assemble (production) validation scenario.

Parameters:

action - configuration action

Since:

5.0.0