Class ConfigurationValidationTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.micronaut.gradle.configuration.validation.tasks.ConfigurationValidationTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class ConfigurationValidationTask extends org.gradle.api.DefaultTask
Failing task that reads the result marker produced by ConfigurationValidationReportTask.
Since:
5.0.0

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FORMAT_BOTH
     
    static final String
    FORMAT_HTML
     
    static final String
    FORMAT_JSON
     

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigurationValidationTask()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    failOnErrors()
    Reads the result marker and fails the build if validation errors are present.
    abstract org.gradle.api.provider.Property<Boolean>
    getEnabledFlag()
    Combined enabled flag (global + scenario).
    abstract org.gradle.api.provider.Property<String>
    getFormat()
    Format used by the report task.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
    Output directory containing the reports.
    abstract org.gradle.api.file.RegularFileProperty
    getResultFile()
    Result marker file produced by *ConfigurationValidationReport tasks.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

  • Constructor Details

    • ConfigurationValidationTask

      public ConfigurationValidationTask()
      Default constructor.

  • Method Details

    • getResultFile

      @InputFile public abstract org.gradle.api.file.RegularFileProperty getResultFile()
      Result marker file produced by *ConfigurationValidationReport tasks.
      Returns:
      marker file

    • getOutputDirectory

      @Internal public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Output directory containing the reports.
      Returns:
      output directory

    • getFormat

      @Input public abstract org.gradle.api.provider.Property<String> getFormat()
      Format used by the report task.
      Returns:
      format

    • getEnabledFlag

      @Internal public abstract org.gradle.api.provider.Property<Boolean> getEnabledFlag()
      Combined enabled flag (global + scenario).
      Returns:
      enabled flag

    • failOnErrors

      public final void failOnErrors() throws Exception
      Reads the result marker and fails the build if validation errors are present.
      Throws:
      Exception - if marker cannot be read or the build should fail