Package org.openrewrite.java

Class ChangePackage

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.java.ChangePackage
All Implemented Interfaces:
Cloneable
public class ChangePackage extends org.openrewrite.Recipe
A recipe that will rename a package name in package statements, imports, and fully-qualified types (see: NOTE).

NOTE: Does not currently transform all possible type references, and accomplishing this would be non-trivial. For example, a method invocation select might refer to field `A a` whose type has now changed to `A2`, and so the type on the select should change as well. But how do we identify the set of all method selects which refer to `a`? Suppose it were prefixed like `this.a`, or `MyClass.this.a`, or indirectly via a separate method call like `getA()` where `getA()` is defined on the super class.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.openrewrite.Recipe

    org.openrewrite.Recipe.Builder, org.openrewrite.Recipe.DelegatingRecipe

  • Field Summary

    Fields inherited from class org.openrewrite.Recipe

    contributors, examples, PANIC

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChangePackage()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
     
    String
    getDisplayName()
     
    String
    getInstanceNameSuffix()
     
    org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>
    getVisitor()
     
    org.openrewrite.Validated<Object>
    validate()
     

    Methods inherited from class org.openrewrite.Recipe

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ChangePackage

      public ChangePackage()

  • Method Details

    • getInstanceNameSuffix

      public String getInstanceNameSuffix()
      Overrides:
      getInstanceNameSuffix 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

    • validate

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

    • getVisitor

      public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getVisitor()
      Overrides:
      getVisitor in class org.openrewrite.Recipe