Class DefaultConfigurationValidationScenario

java.lang.Object

io.micronaut.gradle.configuration.validation.DefaultConfigurationValidationScenario

All Implemented Interfaces:

ConfigurationValidationScenario

public abstract class DefaultConfigurationValidationScenario
extends Object
implements ConfigurationValidationScenario

Default implementation of ConfigurationValidationScenario.

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurationValidationScenario(org.gradle.api.model.ObjectFactory objects)	Creates a scenario with default conventions.

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.file.ConfigurableFileCollection	getClasspath()	Extra or overridden classpath entries used to validate configuration.
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 this scenario.
abstract org.gradle.api.provider.ListProperty<String>	getEnvironments()	Enabled Micronaut environments.
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.file.DirectoryProperty	getOutputDirectory()	Scenario output directory.
abstract org.gradle.api.provider.Property<Boolean>	getOverrideClasspath()	When true, the scenario classpath fully replaces the default classpath computed by the plugin.
abstract org.gradle.api.provider.ListProperty<String>	getResourcesDirs()	Resource directories under ConfigurationValidationExtension.getProjectBaseDir().
abstract org.gradle.api.provider.ListProperty<String>	getSuppressedInjectionErrors()	Dependency injection suppression patterns.
abstract org.gradle.api.provider.ListProperty<String>	getSuppressions()	Suppression patterns.

Methods inherited from class Object

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

Constructor Details

DefaultConfigurationValidationScenario

@Inject
public DefaultConfigurationValidationScenario(org.gradle.api.model.ObjectFactory objects)

Creates a scenario with default conventions.

Parameters:

objects - object factory

Method Details

getEnabled

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

Description copied from interface: ConfigurationValidationScenario

Enables or disables this scenario.

Specified by:

getEnabled in interface ConfigurationValidationScenario

Returns:

enabled flag

getEnvironments

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

Description copied from interface: ConfigurationValidationScenario

Enabled Micronaut environments.

Values map to --env (repeatable).

Specified by:

getEnvironments in interface ConfigurationValidationScenario

Returns:

environments

getFailOnNotPresent

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

Description copied from interface: ConfigurationValidationScenario

Whether unknown configuration properties should be considered errors.

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

Specified by:

getFailOnNotPresent in interface ConfigurationValidationScenario

Returns:

fail-on-not-present flag

getDeduceEnvironments

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

Description copied from interface: ConfigurationValidationScenario

Whether Micronaut environments should be deduced.

Maps to --deduce-environments.

Specified by:

getDeduceEnvironments in interface ConfigurationValidationScenario

Returns:

deduce-environments flag

getFormat

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

Description copied from interface: ConfigurationValidationScenario

Report format.

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

Specified by:

getFormat in interface ConfigurationValidationScenario

Returns:

report format

getSuppressions

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

Description copied from interface: ConfigurationValidationScenario

Suppression patterns.

Each pattern maps to --suppress.

Specified by:

getSuppressions in interface ConfigurationValidationScenario

Returns:

suppression patterns

getSuppressedInjectionErrors

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

Description copied from interface: ConfigurationValidationScenario

Dependency injection suppression patterns.

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

Specified by:

getSuppressedInjectionErrors in interface ConfigurationValidationScenario

Returns:

dependency injection suppression patterns

getOutputDirectory

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

Description copied from interface: ConfigurationValidationScenario

Scenario output directory.

Specified by:

getOutputDirectory in interface ConfigurationValidationScenario

Returns:

output directory

getOverrideClasspath

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

Description copied from interface: ConfigurationValidationScenario

When true, the scenario classpath fully replaces the default classpath computed by the plugin.

Specified by:

getOverrideClasspath in interface ConfigurationValidationScenario

Returns:

override classpath flag

getClasspath

public abstract org.gradle.api.file.ConfigurableFileCollection getClasspath()

Description copied from interface: ConfigurationValidationScenario

Extra or overridden classpath entries used to validate configuration.

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

Specified by:

getClasspath in interface ConfigurationValidationScenario

Returns:

classpath entries

getResourcesDirs

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

Description copied from interface: ConfigurationValidationScenario

Resource directories under ConfigurationValidationExtension.getProjectBaseDir().

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

Specified by:

getResourcesDirs in interface ConfigurationValidationScenario

Returns:

resource directory paths (relative to project base dir)