Package net.octyl.levelheadered

Class HeaderWorkerSourceTask<W extends org.gradle.workers.WorkAction<P>,P extends HeaderWorkParameters>

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.octyl.levelheadered.HeaderWorkerSourceTask<W,P>
Type Parameters:
W - the work action type
P - the work parameters type
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>
Direct Known Subclasses:
HeaderApplyTask, HeaderVerifyTask
public abstract sealed class HeaderWorkerSourceTask<W extends org.gradle.workers.WorkAction<P>,P extends HeaderWorkParameters> extends org.gradle.api.DefaultTask implements LevelHeaderedConfig permits HeaderApplyTask, HeaderVerifyTask
Base class for tasks that perform actions with headers on source files.

  • 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
    Modifier
    Constructor
    Description
    protected
    HeaderWorkerSourceTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract org.gradle.api.provider.ProviderFactory
    getProviderFactory()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSource()
    Returns Source files to process.
    protected abstract org.gradle.api.file.ConfigurableFileCollection
    getSourcesToProcess()
     
    protected abstract org.gradle.workers.WorkerExecutor
    getWorkerExecutor()
     
    void
    runWork(org.gradle.work.InputChanges inputChanges)
    Runs the work action on changed files.

    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

    • HeaderWorkerSourceTask

      protected HeaderWorkerSourceTask()

  • Method Details

    • getWorkerExecutor

      @Inject protected abstract org.gradle.workers.WorkerExecutor getWorkerExecutor()

    • getProviderFactory

      @Inject protected abstract org.gradle.api.provider.ProviderFactory getProviderFactory()

    • getSource

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getSource()
      Returns Source files to process. Will be filtered by LevelHeaderedConfig.getSourceMatchPatterns().
      Returns:
      Source files to process

    • getSourcesToProcess

      @SkipWhenEmpty @IgnoreEmptyDirectories @InputFiles @PathSensitive(NONE) protected abstract org.gradle.api.file.ConfigurableFileCollection getSourcesToProcess()

    • runWork

      public void runWork(org.gradle.work.InputChanges inputChanges) throws IOException
      Runs the work action on changed files.
      Parameters:
      inputChanges - the input changes from Gradle
      Throws:
      IOException - if an I/O error occurs