Interface TaskStep

All Superinterfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.plugins.ExtensionAware, GradleRunningTask, org.gradle.api.Named, org.gradle.api.Task
All Known Implementing Classes:
DownloadModStep, DownloadServerAssetStep, LaunchServerStep, PrepareDownloaderStep, PrepareReinstallStep, TaskStepDefault, TaskStepExec
public interface TaskStep extends GradleRunningTask
Represents an atomic unit of work within a boot lifecycle.

Steps wrap logic into a TaskStep.Options record, allowing for standardized execution of setup ("start") and cleanup ("stop") logic.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    TaskStep.Options
    Configuration for step execution.

    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

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull TaskStep.Options
    options()
     
    default void
    runStep()
    Standard execution flow for the step.

    Methods inherited from interface Comparable

    compareTo

    Methods inherited from interface org.gradle.api.plugins.ExtensionAware

    getExtensions

    Methods inherited from interface GradleRunningTask

    getHytalePluginExtension, run

    Methods inherited from interface org.gradle.api.Task

    configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

  • Method Details

    • runStep

      default void runStep()
      Standard execution flow for the step.

      Runs the start logic, followed by the optional stop logic.

    • options

      @NonNull TaskStep.Options options()
      Returns:
      the configuration options for this step's execution