Class PinTasks.Pin

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.jpos.gradle.PinTasks.Pin
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>
Enclosing class:
PinTasks

@UntrackedTask(because="edits libs.versions.toml in place") public abstract static class PinTasks.Pin extends org.gradle.api.DefaultTask
Pins version entries to specific timestamped snapshot builds, keeping the original SNAPSHOT in a marker comment. With no options, pins every SNAPSHOT-managed entry to its latest build.
  • 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
    Pin()
    Default constructor used by Gradle to instantiate the task.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    run()
    Pins the selected entries, recording the original SNAPSHOT in a marker comment.
    void
    Sets the version key to pin.
    void
    setTo(String version)
    Sets an explicit timestamped snapshot build to pin to.

    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
  • Constructor Details

    • Pin

      public Pin()
      Default constructor used by Gradle to instantiate the task.
  • Method Details

    • setRef

      public void setRef(String ref)
      Sets the version key to pin.
      Parameters:
      ref - version key in [versions], as shown by the 'pins' task (default: all)
    • setTo

      public void setTo(String version)
      Sets an explicit timestamped snapshot build to pin to. The option is named --to because --version is Gradle's own flag.
      Parameters:
      version - timestamped snapshot build (default: latest from repository metadata)
    • run

      public void run() throws IOException
      Pins the selected entries, recording the original SNAPSHOT in a marker comment.
      Throws:
      IOException - if libs.versions.toml cannot be rewritten