Class ConfigurationValidationConfiguration

java.lang.Object

io.micronaut.maven.jsonschema.ConfigurationValidationConfiguration

public final class ConfigurationValidationConfiguration
extends Object

Shared configuration for Micronaut configuration validation.

This type is used as a nested configuration object in multiple mojos.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConfigurationValidationConfiguration.ValidationSet	Scenario-specific configuration.

Constructor Summary

Constructors

Constructor	Description
ConfigurationValidationConfiguration()

Method Summary

Modifier and Type	Method	Description
Boolean	getCacheEnabled()
List<String>	getCacheIgnore()	Resource patterns to ignore when computing cache fingerprints.
Boolean	getDeduceEnvironments()	Controls whether Micronaut may deduce environments.
ConfigurationValidationConfiguration.ValidationSet	getDev()
Boolean	getEnabled()
Boolean	getFailOnNotPresent()	Controls whether validation should fail when a configuration property is not present in the schema.
String	getFormat()	Report format.
File	getOutputDirectory()	Base output directory for reports.
ConfigurationValidationConfiguration.ValidationSet	getPackageValidation()
List<String>	getSuppressions()	Suppression patterns applied to validation results.
ConfigurationValidationConfiguration.ValidationSet	getTest()
void	setCacheEnabled(Boolean cacheEnabled)
void	setCacheIgnore(List<String> cacheIgnore)
void	setDeduceEnvironments(Boolean deduceEnvironments)
void	setDev(ConfigurationValidationConfiguration.ValidationSet dev)
void	setEnabled(Boolean enabled)
void	setFailOnNotPresent(Boolean failOnNotPresent)
void	setFormat(String format)
void	setOutputDirectory(File outputDirectory)
void	setPackageValidation(ConfigurationValidationConfiguration.ValidationSet packageValidation)
void	setSuppressions(List<String> suppressions)
void	setTest(ConfigurationValidationConfiguration.ValidationSet test)

Methods inherited from class Object

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

Constructor Details

ConfigurationValidationConfiguration

public ConfigurationValidationConfiguration()

Method Details

getEnabled

public Boolean getEnabled()

Returns:

Whether configuration validation is enabled. If null, validation is enabled.

setEnabled

public void setEnabled(Boolean enabled)

Parameters:

enabled - Whether configuration validation is enabled.

getSuppressions

public List<String> getSuppressions()

Suppression patterns applied to validation results.

Returns:

The suppression patterns, or null to use no suppressions.

setSuppressions

public void setSuppressions(List<String> suppressions)

Parameters:

suppressions - Suppression patterns.

getFailOnNotPresent

public Boolean getFailOnNotPresent()

Controls whether validation should fail when a configuration property is not present in the schema.

Returns:

Whether to fail on not-present properties. If null, defaults to true.

setFailOnNotPresent

public void setFailOnNotPresent(Boolean failOnNotPresent)

Parameters:

failOnNotPresent - Whether to fail on not-present properties.

getDeduceEnvironments

public Boolean getDeduceEnvironments()

Controls whether Micronaut may deduce environments.

Returns:

Whether to deduce environments. If null, defaults to false.

setDeduceEnvironments

public void setDeduceEnvironments(Boolean deduceEnvironments)

Parameters:

deduceEnvironments - Whether to allow Micronaut to deduce environments.

getFormat

public String getFormat()

Report format.

Returns:

The report format (json, html, or both). If null, defaults to both.

setFormat

public void setFormat(String format)

Parameters:

format - The report format (json, html, or both).

getOutputDirectory

public File getOutputDirectory()

Base output directory for reports.

Returns:

The base output directory. If null, defaults to ${project.build.directory}/micronaut/config-validation.

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

Parameters:

outputDirectory - The base output directory.

getCacheEnabled

public Boolean getCacheEnabled()

Returns:

Whether caching is enabled. If null, defaults to true.

setCacheEnabled

public void setCacheEnabled(Boolean cacheEnabled)

Parameters:

cacheEnabled - Whether caching is enabled.

getCacheIgnore

public List<String> getCacheIgnore()

Resource patterns to ignore when computing cache fingerprints.

Patterns are evaluated using glob syntax against paths relative to each configured resource directory for the active scenario.

Returns:

Ignore patterns, or null to use defaults

setCacheIgnore

public void setCacheIgnore(List<String> cacheIgnore)

Parameters:

cacheIgnore - Ignore patterns

getDev

public ConfigurationValidationConfiguration.ValidationSet getDev()

Returns:

Scenario-specific configuration for mn:run validation (default environment: dev).

setDev

public void setDev(ConfigurationValidationConfiguration.ValidationSet dev)

Parameters:

dev - Scenario-specific configuration for mn:run validation.

getPackageValidation

public ConfigurationValidationConfiguration.ValidationSet getPackageValidation()

Returns:

Scenario-specific configuration for package validation.

setPackageValidation

public void setPackageValidation(ConfigurationValidationConfiguration.ValidationSet packageValidation)

Parameters:

packageValidation - Scenario-specific configuration for package validation.

getTest

public ConfigurationValidationConfiguration.ValidationSet getTest()

Returns:

Scenario-specific configuration for test validation (default environment: test).

setTest

public void setTest(ConfigurationValidationConfiguration.ValidationSet test)

Parameters:

test - Scenario-specific configuration for test validation.