Package net.octyl.levelheadered

Class HeaderVerifyTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.octyl.levelheadered.HeaderWorkerSourceTask<net.octyl.levelheadered.HeaderVerifyWorkAction,net.octyl.levelheadered.HeaderVerifyWorkAction.Parameters>
net.octyl.levelheadered.HeaderVerifyTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, LevelHeaderedConfig, 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>
@DisableCachingByDefault(because="Produces no useful output") public abstract non-sealed class HeaderVerifyTask extends HeaderWorkerSourceTask<net.octyl.levelheadered.HeaderVerifyWorkAction,net.octyl.levelheadered.HeaderVerifyWorkAction.Parameters> implements LevelHeaderedConfig
Task that verifies headers on source files.

Only abstract for Gradle, not to be implemented by users.

  • Nested Class Summary

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

    org.gradle.api.Named.Namer

  • Field Summary

    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
    HeaderVerifyTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getHeaderApplyTaskPath()
    Returns the path of the corresponding header apply task.

    Methods inherited from class net.octyl.levelheadered.HeaderWorkerSourceTask

    getProviderFactory, getSource, getSourcesToProcess, getWorkerExecutor, runWork

    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 java.lang.Object

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

    Methods inherited from interface net.octyl.levelheadered.LevelHeaderedConfig

    getHeaderTemplate, getRewriters, getSourceMatchPatterns, getTemplateVariables

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • HeaderVerifyTask

      public HeaderVerifyTask()

  • Method Details

    • getHeaderApplyTaskPath

      @Console public abstract org.gradle.api.provider.Property<String> getHeaderApplyTaskPath()
      Returns the path of the corresponding header apply task. This is the task that can be run to fix any header violations found by this task.

      If not set, a generic message will be shown instead.

      Returns:
      the path of the corresponding header apply task