Class GeneratePluginDescriptionTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.vouncherstudios.strawberry.minecraft.plugin.task.GeneratePluginDescriptionTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, 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="Generator configuration is not yet modeled as task inputs") public abstract class GeneratePluginDescriptionTask extends org.gradle.api.DefaultTask
The generate plugin description gradle task. It will generate the plugin description based on user defined Strawberry configuration.

  • 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
    GeneratePluginDescriptionTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generate()
    The task action to generate the plugin description.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectDescription()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectVersion()
     
    void
    setGenerators(StrawberryExtension strawberry)
    Sets the generators based on the provided strawberry extension.
    void
    validate()
    Validates the plugin description.

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • GeneratePluginDescriptionTask

      public GeneratePluginDescriptionTask()

  • Method Details

    • getProjectVersion

      @Input public abstract org.gradle.api.provider.Property<String> getProjectVersion()

    • getProjectDescription

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getProjectDescription()

    • getOutputDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()

    • generate

      public void generate()
      The task action to generate the plugin description. It iterates over the set of generators and calls the generate method on each one.

    • validate

      public void validate() throws InvalidPluginDescriptionException
      Validates the plugin description. It iterates over the set of generators and calls the validate method on each one.
      Throws:
      InvalidPluginDescriptionException - if the plugin description is invalid

    • setGenerators

      public void setGenerators(@Nonnull StrawberryExtension strawberry)
      Sets the generators based on the provided strawberry extension. It checks the generator types from the extension and adds the corresponding generators to the set.
      Parameters:
      strawberry - the strawberry extension