Package org.openrewrite.maven

Class UpgradeDependencyVersion

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.ScanningRecipe<Set<GroupArtifact>>
org.openrewrite.maven.UpgradeDependencyVersion
All Implemented Interfaces:
Cloneable
public class UpgradeDependencyVersion extends org.openrewrite.ScanningRecipe<Set<GroupArtifact>>
Upgrade the version of a dependency by specifying a group or group and artifact using Node Semver advanced range selectors, allowing more precise control over version updates to patch or minor releases.

NOTES:

  • If a version is defined as a property, this recipe will only change the property value if the property exists within the same pom.
  • This recipe will alter the managed version of the dependency if it exists in the pom.
  • The default behavior for managed dependencies is to leave them unaltered unless the "overrideManagedVersion" is set to true.

    • Field Summary

      Fields inherited from class org.openrewrite.Recipe

      contributors, examples, PANIC

    • Constructor Summary

      Constructors
      Constructor
      Description
      UpgradeDependencyVersion()
       

    • Method Summary

      Modifier and Type
      Method
      Description
      String
      getDescription()
       
      String
      getDisplayName()
       
      Set<GroupArtifact>
      getInitialValue(org.openrewrite.ExecutionContext ctx)
       
      org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>
      getScanner(Set<GroupArtifact> projectArtifacts)
       
      org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>
      getVisitor(Set<GroupArtifact> projectArtifacts)
       
      org.openrewrite.Validated<Object>
      validate()
       

      Methods inherited from class org.openrewrite.ScanningRecipe

      generate, generate, getVisitor

      Methods inherited from class org.openrewrite.Recipe

      addDataTable, causesAnotherCycle, clone, createRecipeDescriptor, equals, getContributors, getDataTableDescriptors, getDescriptor, getEstimatedEffortPerOccurrence, getExamples, getJacksonPolymorphicTypeTag, getMaintainers, getName, getRecipeList, getTags, hashCode, maxCycles, noop, run, run, run, setContributors, setExamples, validate, validateAll

      Methods inherited from class java.lang.Object

      finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Details

      • UpgradeDependencyVersion

        public UpgradeDependencyVersion()

    • Method Details

      • validate

        public org.openrewrite.Validated<Object> validate()
        Overrides:
        validate in class org.openrewrite.Recipe

      • getDisplayName

        public String getDisplayName()
        Specified by:
        getDisplayName in class org.openrewrite.Recipe

      • getDescription

        public String getDescription()
        Specified by:
        getDescription in class org.openrewrite.Recipe

      • getInitialValue

        public Set<GroupArtifact> getInitialValue(org.openrewrite.ExecutionContext ctx)
        Specified by:
        getInitialValue in class org.openrewrite.ScanningRecipe<Set<GroupArtifact>>

      • getScanner

        public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getScanner(Set<GroupArtifact> projectArtifacts)
        Specified by:
        getScanner in class org.openrewrite.ScanningRecipe<Set<GroupArtifact>>

      • getVisitor

        public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getVisitor(Set<GroupArtifact> projectArtifacts)
        Overrides:
        getVisitor in class org.openrewrite.ScanningRecipe<Set<GroupArtifact>>