Package net.kyori.blossom

Class GenerateTemplates

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.kyori.blossom.GenerateTemplates
All Implemented Interfaces:
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 GenerateTemplates extends org.gradle.api.DefaultTask
Generate real files based on templates and input parameters.
Since:
2.0.0

  • 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    GenerateTemplates()
    Create a new task (NOT to be called directly).

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract @NotNull org.gradle.api.provider.Property<TemplateSet>
    getBaseSet()
    The set the template is generated from.
    protected abstract @NotNull org.gradle.api.file.ConfigurableFileCollection
    getIncludesDirectories()
    Files that can be included in templates, but that are not themselves templates.
    abstract @NotNull org.gradle.api.file.DirectoryProperty
    getOutputDir()
    Destination directory for template output.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getPebbleClasspath()
    The worker classpath.
    protected abstract @NotNull org.gradle.api.file.ConfigurableFileCollection
    getSourceDirectories()
    Source directory for templates to process.
    protected abstract org.gradle.workers.WorkerExecutor
    getWorkerExecutor()
     

    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, 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 Details

    • GenerateTemplates

      public GenerateTemplates()
      Create a new task (NOT to be called directly).
      Since:
      2.0.0

  • Method Details

    • getBaseSet

      @NotNull public abstract @NotNull org.gradle.api.provider.Property<TemplateSet> getBaseSet()
      The set the template is generated from.
      Returns:
      the template set
      Since:
      2.0.0

    • getIncludesDirectories

      @InputFiles @NotNull protected abstract @NotNull org.gradle.api.file.ConfigurableFileCollection getIncludesDirectories()
      Files that can be included in templates, but that are not themselves templates.

      Derived from the TemplateSet.

      Returns:
      the files to include
      Since:
      2.0.0

    • getSourceDirectories

      @InputFiles @SkipWhenEmpty @NotNull protected abstract @NotNull org.gradle.api.file.ConfigurableFileCollection getSourceDirectories()
      Source directory for templates to process.
      Returns:
      the source directory
      Since:
      2.0.0

    • getOutputDir

      @OutputDirectory @NotNull public abstract @NotNull org.gradle.api.file.DirectoryProperty getOutputDir()
      Destination directory for template output.
      Returns:
      the destination directory
      Since:
      2.0.0

    • getPebbleClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getPebbleClasspath()
      The worker classpath. This should include Pebble and SnakeYAML engine.
      Returns:
      the worker classpath
      Since:
      2.0.0

    • getWorkerExecutor

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