Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.tools

Class BasicRefactoringTool.AbstractRenamer

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
org.eclipse.persistence.jpa.jpql.parser.AbstractTraverseChildrenVisitor
org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool.AbstractRenamer
All Implemented Interfaces:
ExpressionVisitor
Direct Known Subclasses:
BasicRefactoringTool.AttributeNameRenamer, BasicRefactoringTool.ClassNameRenamer, BasicRefactoringTool.EntityNameRenamer, BasicRefactoringTool.EnumConstantRenamer, BasicRefactoringTool.ResultVariableNameRenamer, BasicRefactoringTool.VariableNameRenamer
Enclosing class:
BasicRefactoringTool
protected abstract class BasicRefactoringTool.AbstractRenamer extends AbstractTraverseChildrenVisitor
The abstract class that all refactoring classes should extend, it automatically provides the MultiTextEdit that will hold the TextEdit objects that are related to the same refactoring event.

  • Field Details

    • textEdits

      protected List<TextEdit> textEdits
      The list of TextEdit objects that were created for each refactoring operation.

  • Constructor Details

    • AbstractRenamer

      protected AbstractRenamer()
      Creates a new AbstractRenamer.

  • Method Details

    • addTextEdit

      protected void addTextEdit(Expression expression, int extraOffset, String oldValue, String newValue)
      Adds a new TextEdit with the given information.
      Parameters:
      expression - The Expression which should be refactored, it will be used to retrieve the offset of the change
      extraOffset - Additional offset that will be added to the given Expression's offset, which is the length of the string representation of what is before it
      oldValue - The old value to change to the new one
      newValue - The new value

    • addTextEdit

      protected void addTextEdit(Expression expression, String oldValue, String newValue)
      Adds a new TextEdit with the given information.
      Parameters:
      expression - The Expression which should be refactored, it will be used to retrieve the offset of the change
      oldValue - The old value to change to the new one
      newValue - The new value

    • buildTextEdit

      protected TextEdit buildTextEdit(int offset, String oldValue, String newValue)
      Creates a new TextEdit for the given refactoring information.
      Parameters:
      offset - The position where the change should be made within the actual JPQL fragment
      oldValue - The old value to change to the new one
      newValue - The new value
      Returns:
      A new TextEdit

    • reposition

      protected int reposition(int offset)
      Repositions the given position that is based on the generated JPQL query to be the position from the JPQL fragment that was parsed.
      Parameters:
      offset - The position within the string generated by Expression.toActualText()
      Returns:
      The position within the JPQL fragment that was passed to the refactoring tool