Class MetaTask

  • All Implemented Interfaces:
    kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

    @CacheableTask() 
    public abstract class MetaTask
    extends DefaultTask
                        

    A task which generates a new generator (meta). Useful for redistributable generator packages.

    Author:

    Jim Schubert

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      MetaTask()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract ProjectLayout getLayout()
      abstract Property<String> getGeneratorName() The human-readable name of the new generator to create.
      abstract Property<String> getPackageName() The Java package name for the generated generator class.
      abstract DirectoryProperty getOutputFolder() The directory where the new generator project files will be written.
      final Unit doWork()
      final Unit set(DirectoryProperty $self, String path) Extension function to allow setting outputFolder with a String path in Kotlin DSL.
      final Unit setOutputFolderAsString(String path) Groovy-compatible setter for outputFolder property.
      • Methods inherited from class org.gradle.api.DefaultTask

        getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
      • Methods inherited from class org.gradle.api.Task

        configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getConvention, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
      • Methods inherited from class kotlin.Comparable

        compareTo
      • Methods inherited from class org.gradle.api.internal.TaskInternal

        acceptServiceReferences, appendParallelSafeAction, hasTaskActions, prependParallelSafeAction
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MetaTask

        MetaTask()
    • Method Detail

      • getLayout

        @Inject() abstract ProjectLayout getLayout()
      • getGeneratorName

        @Input() abstract Property<String> getGeneratorName()

        The human-readable name of the new generator to create.

        Used to derive the generator class name and the template resource directory.

      • getPackageName

        @Input() abstract Property<String> getPackageName()

        The Java package name for the generated generator class. Defaults to org.openapitools.codegen.

      • getOutputFolder

        @OutputDirectory() abstract DirectoryProperty getOutputFolder()

        The directory where the new generator project files will be written. Defaults to the current project directory.

      • set

         final Unit set(DirectoryProperty $self, String path)

        Extension function to allow setting outputFolder with a String path in Kotlin DSL. Example: outputFolder.set("$buildDir/generated")