Package io.openapiprocessor.gradle

Class OpenApiProcessorTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
    public abstract class OpenApiProcessorTask
extends org.gradle.api.DefaultTask
    processor task. Uses a worker executor to run the processor with an isolated "openapiProcessor" configuration classpath.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        org.gradle.api.Task.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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.gradle.api.provider.Property<java.lang.String> getApiDir()
      Source directory (i.e.
      abstract org.gradle.api.file.ConfigurableFileCollection getDependencies()
      The dependencies of the processor.
      abstract org.gradle.api.provider.Property<java.lang.String> getProcessorName()
      name of the processor.
      abstract org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.Object> getProcessorProps()
      properties configured by the processor closure in the OpenApiProcessorExtension.
      abstract org.gradle.api.provider.Property<java.lang.String> getTargetDir()
      Target directory for the sources generated by the processor.
      abstract org.gradle.workers.WorkerExecutor getWorkerExecutor()  
      void runProcessor()
      runs the configured processor with its own classloader.

      • 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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

        appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, 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 org.gradle.api.Task

        doNotTrackState, getConvention, notCompatibleWithConfigurationCache

    • Constructor Detail

      • OpenApiProcessorTask

        public OpenApiProcessorTask()

    • Method Detail

      • getApiDir

        @InputDirectory
public abstract org.gradle.api.provider.Property<java.lang.String> getApiDir()
        Source directory (i.e. parent) of the openapi.yaml input file. Used by gradle for the up-to-date check.
        Returns:
        parent directory of the openapi.yaml

      • getTargetDir

        @OutputDirectory
public abstract org.gradle.api.provider.Property<java.lang.String> getTargetDir()
        Target directory for the sources generated by the processor. Used by gradle for the up-to-date check.
        Returns:
        target directory

      • getDependencies

        @Classpath
public abstract org.gradle.api.file.ConfigurableFileCollection getDependencies()
        The dependencies of the processor.
        Returns:
        the processor dependencies

      • getProcessorName

        @Internal
public abstract org.gradle.api.provider.Property<java.lang.String> getProcessorName()
        name of the processor.
        Returns:
        the processor name.

      • getProcessorProps

        @Internal
public abstract org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.Object> getProcessorProps()
        properties configured by the processor closure in the OpenApiProcessorExtension.
        Returns:
        the processor properties

      • getWorkerExecutor

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

      • runProcessor

        public void runProcessor()
        runs the configured processor with its own classloader.