Package com.vaadin.copilot.javarewriter

Class JavaRewriterUtil

java.lang.Object
com.vaadin.copilot.javarewriter.JavaRewriterUtil
public class JavaRewriterUtil extends Object
Util methods for rewriting Java

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addFieldAfter(com.github.javaparser.ast.body.FieldDeclaration newField, com.github.javaparser.ast.body.FieldDeclaration reference)
    Adds a field declaration after the given reference field.
    static com.github.javaparser.ast.expr.MethodCallExpr
    addFunctionCall(ComponentInfo componentInfo, String function, List<com.github.javaparser.ast.expr.Expression> parameterExpressions)
    Adds a function call to the given component.
    static void
    addImport(com.github.javaparser.ast.CompilationUnit compilationUnit, String qualifiedName)
    Adds an import to the given compilation unit if it is not already imported.
    static void
    addImport(com.github.javaparser.ast.CompilationUnit compilationUnit, String qualifiedName, boolean isStatic, boolean isAsterisk)
    Adds an import to the given compilation unit if it is not already imported.
    static boolean
    appendExpressionAsNextSiblingInBlockAncestor(com.github.javaparser.ast.Node original, com.github.javaparser.ast.stmt.Statement newExpression)
    Appends new expression to original one as sibling in a block statement.
    static boolean
    checkExpressionInLoop(com.github.javaparser.ast.expr.Expression expression)
    Checks if given expression is descendant of loop statements.
    static boolean
    checkMethodHasExpressionCalledInLoop(com.github.javaparser.ast.expr.Expression expression)
    Determines whether all invocations of the method containing the given expression are made from within a loop construct (e.g., for, while, or do-while) via checkExpressionInLoop(Expression)
    static <T extends com.github.javaparser.ast.Node>
    T
    clone(T node)
    Clones the node in a way that does not mess up the lexical printer.
    static boolean
    constructorArgumentIsArray(com.github.javaparser.ast.expr.ObjectCreationExpr expr, int argIndex)
    Resolves object creation expression to access Class API to get argument.isArray() value of given argument index.
    static boolean
    containsMethodInEmptyConstructorCall(ComponentInfo componentInfo, String methodName)
    Analyzes bytecode of the given component to search for method with methodName is called in an empty constructor
    static com.github.javaparser.ast.expr.ObjectCreationExpr
    createComponentConstructor(JavaComponent javaComponent, com.github.javaparser.ast.type.ClassOrInterfaceType componentType, String dataEntityRecordName, Consumer<String> importAdder)
    Creates the convenient component constructor for a new JavaComponent to be added to the code.
    static ComponentInfo
    createComponentInfoForTemplateComponent(JavaSource javaSource, com.github.javaparser.ast.expr.ObjectCreationExpr objectCreationExpr, AttachExpression attachExpression)
     
    static com.github.javaparser.ast.type.Type
    createEmptyType()
    Creates a Type that can be used in generics to end up with `invalid input: '<'>`.
    static com.github.javaparser.ast.expr.MethodCallExpr
    createMethodCall(com.github.javaparser.ast.expr.Expression scope, String function, com.github.javaparser.ast.expr.Expression... parameterExpressions)
     
    static boolean
    expressionsInDifferentBlocks(com.github.javaparser.ast.expr.Expression expr1, com.github.javaparser.ast.expr.Expression expr2)
    Checks given two expression are in different blocks.
    static JavaRewriter.ExtractInlineVariableResult
    extractInlineVariableToLocalVariable(ComponentInfo componentInfo)
    Extracts an inline variable to local variable with a new variable name.
    static int
    findArgumentIndex(com.github.javaparser.ast.nodeTypes.NodeWithArguments<?> nodeWithArgs, com.github.javaparser.ast.expr.Expression argExpression)
    Iterates arguments to check any of the argument equals to argExpression.
    static int
    findBlockStatementIndex(com.github.javaparser.ast.Node node)
    Finds the index of the statement that wraps the given node in the closest block statement.
    static List<com.github.javaparser.ast.expr.MethodCallExpr>
    findCalls(Class<?> classWithMethods, ComponentInfo componentInfo)
    Find all calls done to methods in the given class through a reference to the given component.
    static Optional<Constructor<?>>
    findConstructor(Class<? extends com.vaadin.flow.component.Component> componentType, com.github.javaparser.resolution.Resolvable<com.github.javaparser.resolution.declarations.ResolvedConstructorDeclaration> resolvable)
    Finds constructor for the given component from the constructor that is provided by Resolvable implementation
    static int
    findDeclarationIndex(com.github.javaparser.ast.Node node)
    Finds the index of the given node in the block statement.
    static com.github.javaparser.ast.body.FieldDeclaration
    findFieldDeclaration(com.github.javaparser.ast.Node nodeInClass, String fieldName)
    Finds the field declaration for the given field name in the class of the given node.
    static String
    findFreeRecordName(String base, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration block)
     
    static String
    findFreeVariableName(ComponentInfo componentInfo, com.github.javaparser.ast.stmt.BlockStmt block)
    Finds a free variable name based on the component type.
    static String
    findFreeVariableName(String base, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration block)
    Finds a free field name based on the given base name.
    static String
    findFreeVariableName(String base, com.github.javaparser.ast.stmt.BlockStmt block)
    Finds a free variable name based on the given base name.
    static com.github.javaparser.ast.body.FieldDeclaration
    findIdAnnotatedField(String id, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classType)
     
    static InsertionPoint
    findLocationAfter(com.github.javaparser.ast.Node node)
    Finds the insert location after of given expression.
    static InsertionPoint
    findLocationAtEnd(com.github.javaparser.ast.stmt.Statement statement)
    Finds the insert location at the end of the code block containing the given statement.
    static InsertionPoint
    findLocationBefore(com.github.javaparser.ast.Node node)
    Finds the insert location before of given expression.
    static List<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCallNonStatements(ComponentInfo componentDefinition)
    Finds usage of the variable outside of method call statements, i.e. all usage not reported by findMethodCallStatements(ComponentInfo).
    static Stream<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCallNonStatements(ComponentInfo componentDefinition, String functionName)
    Finds usage of the variable outside of method call statements, i.e. all usage not reported by findMethodCallStatements(ComponentInfo).
    static List<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCalls(ComponentInfo componentInfo)
    Finds all method calls that are related to the given component.
    static List<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCalls(ComponentInfo componentInfo, com.github.javaparser.ast.Node.TreeTraversal traversalOrder)
    Finds all method calls that are related to the given component.
    static List<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCallStatements(ComponentInfo componentDefinition)
    Find all method calls that are statements, i.e. calls like foo.bar() or baz.qux("zug")).
    static Stream<com.github.javaparser.ast.expr.MethodCallExpr>
    findMethodCallStatements(ComponentInfo componentInfo, String functionName)
    Find all method calls statements for the given function, i.e. calls like foo.bar() or baz.qux("zug")).
    static Stream<com.github.javaparser.ast.expr.Expression>
    findNameReferences(String variableName, com.github.javaparser.ast.stmt.BlockStmt scope)
    Finds all name references to the given variable name in the given scope.
    static List<com.github.javaparser.ast.expr.Expression>
    findParameterUsage(ComponentInfo componentDefinition)
    Find all expressions where the given component is used as a call parameter.
    static Optional<com.github.javaparser.ast.expr.Expression>
    findReference(com.github.javaparser.ast.NodeList<com.github.javaparser.ast.expr.Expression> nodes, ComponentInfo componentDefinition)
    Finds a node among the nodes which refer to the given component.
    static List<com.github.javaparser.ast.stmt.ReturnStmt>
    findReturnStatements(ComponentInfo componentInfo)
    Find return statements referring to the component.
    static Object
    fromExpression(com.github.javaparser.ast.expr.Expression arg, com.github.javaparser.resolution.types.ResolvedType expectedType)
    Parses the given expression and returns the object it represents.
    static boolean
    functionAffectsVariableName(String functionName)
    Checks if the value passed to the given function affects the variable name generated for the component.
    static String
    generateVariableName(JavaComponent javaComponent, com.github.javaparser.ast.type.ClassOrInterfaceType type, InsertionPoint insertionPoint)
    Provides a free name to be used when adding a new component.
    static String
    getAnnotationValue(com.github.javaparser.ast.expr.AnnotationExpr annotation)
    Gets the value attribute of the given annotation or null if no value is found.
    static Optional<com.github.javaparser.ast.expr.Expression>
    getAttachArgument(ComponentInfo component)
    Finds the attach argument reference of the given component.
    static com.github.javaparser.ast.expr.Expression
    getAttachArgumentOrThrow(ComponentInfo component)
    Find the attach argument reference of given component or throws IllegalArgumentException if not found.
    static Enum<?>
    getEnumValue(Class<?> componentType, String setterName, String value)
     
    static String
    getFieldOrVariableName(ComponentInfo componentInfo)
    Gets the field or local variable name for the given component.
    static String
    getJavaIdentifier(String str, int maxLength)
    Converts the given string into a valid Java identifier.
    static String
    getMappedProperty(Constructor<?> c, int propertyIndex)
    Returns a property used in a constructor at the given index
    static Optional<com.github.javaparser.ast.body.MethodDeclaration>
    getMethodIfEmpty(com.github.javaparser.ast.stmt.BlockStmt createScope)
     
    static Optional<com.github.javaparser.ast.expr.Expression>
    getOutermostScope(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr)
    Gets the outermost scope for a chain of method calls.
    static List<UIServiceCreator.FieldInfo>
    getPropertiesInSourceOrder(String itemType)
    Parses the given class and finds bean properties in the order they are defined.
    static String
    getPropertyName(String setter)
    Gets the camel case property name for the given setter.
    static Optional<String>
    getQualifiedClassName(com.github.javaparser.resolution.declarations.ResolvedDeclaration resolvedDeclaration)
    Gets the qualified class name of ResolvedDeclaration when the given declaration is an instance of ResolvedValueDeclaration For generic classes such as Binder, it does not return the generic type instead it would return com.vaadin.flow.data.binder.Binder
    static Optional<com.github.javaparser.ast.expr.Expression>
    getScopeIgnoreComposite(ComponentInfo componentInfo, com.github.javaparser.ast.expr.MethodCallExpr expr)
    Returns the scope by ignoring the getContent() if component is in a composite container.
    static JavaRewriter.SetterAndValue
    getSetterAndValue(Class<?> componentType, String property, Object value)
    Gets the setter name and value for the given component type, property and value.
    static String
    getSetterName(String property, Class<?> type, boolean includeReactConversions)
    Gets the setter name for the given property.
    static Optional<String>
    getSingleStringParamConstructor(com.github.javaparser.ast.type.ClassOrInterfaceType type, Set<String> setters)
    Returns the single String parameter name from mapped properties of the component that matches an existing single String parameter constructor of the component
    static String
    getSymbolNameFromJavaParserException(com.github.javaparser.resolution.UnsolvedSymbolException e)
    Gets the name of the symbol that could not be resolved.
    static String
    getVariableNameForAdd(ComponentInfo referenceComponent)
     
    static com.github.javaparser.ast.expr.ObjectCreationExpr
    getWrapperDivObjectCreationExpr(com.github.javaparser.ast.CompilationUnit compilationUnit, com.github.javaparser.ast.NodeList<com.github.javaparser.ast.expr.Expression> args)
    Creates a Div creation expression new Div() with given arguments.
    static boolean
    hasMethod(Class<?> type, String methodName)
    Checks if the given component type has the given method.
    static boolean
    hasSetterForType(Class<?> componentType, String setterName, Class<?> valueType)
     
    static boolean
    hasSingleParameterMethod(Class<? extends com.vaadin.flow.component.Component> type, String func)
    Checks if the given component type has a method with the given name, taking one parameter.
    static boolean
    isComponentOrComponentArray(Class<?> type)
     
    static boolean
    isConstructorArgumentFlowComponentType(com.github.javaparser.ast.expr.ObjectCreationExpr expr, int argIndex)
    Resolves object creation expression to access Class API to check if given argument in the argIndex exactly equals to com.vaadin.flow.component.Component
    static boolean
    isLocationRefersSource(ComponentTypeAndSourceLocation typeAndSourceLocation, com.github.javaparser.ast.CompilationUnit compilationUnit)
    Checks if given attach and create location refers to a source file instead of instance creation.
    static boolean
    isNodeInCompositeClass(com.github.javaparser.ast.Node node)
    Checks if the given node is a child of a Composite
    static boolean
    isObjectCreationExprInConstructor(ComponentInfo componentInfo)
    Checks if the given component is created inside the constructor of the class (as opposed to being created in another method).
    static boolean
    isVariableNameAutoGenerated(ComponentInfo componentInfo, String currentText, String currentLabel)
    Checks if the given component has a variable name that is auto-generated based on the type/label/text of the component.
    static void
    moveAboveMethodsAndConstructors(com.github.javaparser.ast.body.BodyDeclaration<?> toMove, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classOrInterface)
     
    static String
    regenerateVariableName(ComponentInfo componentInfo, String newText, String newLabel)
    Regenerates the variable name for the given component.
    static boolean
    removeArgumentCalls(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr, List<? extends com.github.javaparser.ast.expr.Expression> argumentsToRemove, boolean removeMethodIfNoArgs)
    Removes the given arguments from the given method call.
    static void
    removeArgumentCalls(List<com.github.javaparser.ast.expr.MethodCallExpr> methods, List<? extends com.github.javaparser.ast.expr.Expression> argumentsToRemove, boolean removeMethodIfNoArgs)
    Removes the given arguments from the given method calls.
    static void
    removeFromChainedStyleCall(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr)
    Removes the given method call from a getStyle call chain.
    static boolean
    removeFromStringConcatenation(com.github.javaparser.ast.Node node)
    Removes the given node from a string concatenation expression.
    static void
    removeStatement(com.github.javaparser.ast.Node node)
    Removes the statement that wraps the given node.
    static boolean
    setNameExprScope(com.github.javaparser.ast.expr.MethodCallExpr newCall, com.github.javaparser.ast.expr.NameExpr nameExpr)
    Sets the name expression scope for the given method call.
    static Predicate<com.github.javaparser.ast.expr.MethodCallExpr>
    testMethodInClass(Class<?> classWithMethods, ComponentInfo componentInfo)
    Looks for given method call is a member of given class for the component
    static boolean
    typesEqual(com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration methodDeclaration1, com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration methodDeclaration2)
    Compares two ResolvedMethodDeclaration instances to determine if they are semantically equivalent in terms of their signature and declaring context.
    static boolean
    typesEqual(com.github.javaparser.resolution.types.ResolvedType javaParserType, Class<?> javaReflectionType)
    Checks if the given type is equal to the given reflection type.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • createMethodCall

      public static com.github.javaparser.ast.expr.MethodCallExpr createMethodCall(com.github.javaparser.ast.expr.Expression scope, String function, com.github.javaparser.ast.expr.Expression... parameterExpressions)

    • fromExpression

      public static Object fromExpression(com.github.javaparser.ast.expr.Expression arg, com.github.javaparser.resolution.types.ResolvedType expectedType)
      Parses the given expression and returns the object it represents.

      If the argument is a null literal, it is returned as is. Method call expressions are also returned as is.

      Parameters:
      arg - the expression to parse
      expectedType - the expected type of the object or null if unknown
      Returns:
      the object represented by the expression

    • findNameReferences

      public static Stream<com.github.javaparser.ast.expr.Expression> findNameReferences(String variableName, com.github.javaparser.ast.stmt.BlockStmt scope)
      Finds all name references to the given variable name in the given scope.
      Parameters:
      variableName - the variable name
      scope - the scope
      Returns:
      a stream of name references

    • findMethodCallStatements

      public static List<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCallStatements(ComponentInfo componentDefinition)
      Find all method calls that are statements, i.e. calls like foo.bar() or baz.qux("zug")). Does not find usage of the variable in other expressions, like otherFunction("something" + foo.bar())
      Parameters:
      componentDefinition - the component to look for
      Returns:
      a list of method calls

    • findMethodCallStatements

      public static Stream<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCallStatements(ComponentInfo componentInfo, String functionName)
      Find all method calls statements for the given function, i.e. calls like foo.bar() or baz.qux("zug")). Does not find usage of the variable in other expressions, like otherFunction("something" + foo.bar())
      Parameters:
      componentInfo - the component to look for
      functionName - the function name to look for
      Returns:
      a list of method calls

    • findMethodCallNonStatements

      public static List<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCallNonStatements(ComponentInfo componentDefinition)
      Finds usage of the variable outside of method call statements, i.e. all usage not reported by findMethodCallStatements(ComponentInfo).
      Parameters:
      componentDefinition - the component to look for
      Returns:
      a list of method calls

    • findMethodCallNonStatements

      public static Stream<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCallNonStatements(ComponentInfo componentDefinition, String functionName)
      Finds usage of the variable outside of method call statements, i.e. all usage not reported by findMethodCallStatements(ComponentInfo).
      Parameters:
      componentDefinition - the component to look for
      functionName - the function name to look for
      Returns:
      a list of method calls

    • findMethodCalls

      public static List<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCalls(ComponentInfo componentInfo)
      Finds all method calls that are related to the given component.
      Parameters:
      componentInfo - the component to look for
      Returns:
      a list of method calls

    • findMethodCalls

      public static List<com.github.javaparser.ast.expr.MethodCallExpr> findMethodCalls(ComponentInfo componentInfo, com.github.javaparser.ast.Node.TreeTraversal traversalOrder)
      Finds all method calls that are related to the given component.
      Parameters:
      componentInfo - the component to look for
      traversalOrder - the order in which the nodes are traversed
      Returns:
      a list of method calls

    • findParameterUsage

      public static List<com.github.javaparser.ast.expr.Expression> findParameterUsage(ComponentInfo componentDefinition)
      Find all expressions where the given component is used as a call parameter.
      Parameters:
      componentDefinition - the component to look for
      Returns:
      a list of expressions

    • extractInlineVariableToLocalVariable

      public static JavaRewriter.ExtractInlineVariableResult extractInlineVariableToLocalVariable(ComponentInfo componentInfo)
      Extracts an inline variable to local variable with a new variable name. The new variable is created in the same block as the inline variable just before the replacement.
      Parameters:
      componentInfo - Component info
      Returns:
      Block, new variable name and index
      Throws:
      CopilotException - if the inline variable cannot be extracted

    • isLocationRefersSource

      public static boolean isLocationRefersSource(ComponentTypeAndSourceLocation typeAndSourceLocation, com.github.javaparser.ast.CompilationUnit compilationUnit)
      Checks if given attach and create location refers to a source file instead of instance creation.
      Parameters:
      typeAndSourceLocation - the type and source location to check
      compilationUnit - the compilation unit that contains the code
      Returns:
      true if given source location and compilation unit refers to source file, false otherwise

    • hasSingleParameterMethod

      public static boolean hasSingleParameterMethod(Class<? extends com.vaadin.flow.component.Component> type, String func)
      Checks if the given component type has a method with the given name, taking one parameter.
      Parameters:
      type - The component type
      func - The method name
      Returns:
      true if the method exists, false otherwise

    • findBlockStatementIndex

      public static int findBlockStatementIndex(com.github.javaparser.ast.Node node)
      Finds the index of the statement that wraps the given node in the closest block statement.
      Parameters:
      node - The node to find the wrapping statement for
      Returns:
      The index of the statement in the block statement

    • findDeclarationIndex

      public static int findDeclarationIndex(com.github.javaparser.ast.Node node)
      Finds the index of the given node in the block statement.
      Parameters:
      node - The node to find the index for
      Returns:
      The index of the node in the block statement or -1 if not found

    • findFreeVariableName

      public static String findFreeVariableName(ComponentInfo componentInfo, com.github.javaparser.ast.stmt.BlockStmt block)
      Finds a free variable name based on the component type.
      Parameters:
      componentInfo - The component info
      block - The block the variable will be used in
      Returns:
      A free variable name

    • findFreeVariableName

      public static String findFreeVariableName(String base, com.github.javaparser.ast.stmt.BlockStmt block)
      Finds a free variable name based on the given base name.
      Parameters:
      base - The base name
      block - The block the variable will be used in
      Returns:
      A free variable name

    • findFreeVariableName

      public static String findFreeVariableName(String base, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration block)
      Finds a free field name based on the given base name.
      Parameters:
      base - The base name
      block - The ClassOrInterfaceDeclaration the variable will be used in
      Returns:
      A free variable name

    • findFreeRecordName

      public static String findFreeRecordName(String base, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration block)

    • removeStatement

      public static void removeStatement(com.github.javaparser.ast.Node node)
      Removes the statement that wraps the given node.
      Parameters:
      node - the node to remove

    • removeFromStringConcatenation

      public static boolean removeFromStringConcatenation(com.github.javaparser.ast.Node node)
      Removes the given node from a string concatenation expression.
      Parameters:
      node - the node to remove
      Returns:
      true if the node was removed, false otherwise

    • findReference

      public static Optional<com.github.javaparser.ast.expr.Expression> findReference(com.github.javaparser.ast.NodeList<com.github.javaparser.ast.expr.Expression> nodes, ComponentInfo componentDefinition)
      Finds a node among the nodes which refer to the given component.
      Parameters:
      nodes - the nodes to search
      componentDefinition - the component definition
      Returns:
      the first node that refers to the component, if any

    • findFieldDeclaration

      public static com.github.javaparser.ast.body.FieldDeclaration findFieldDeclaration(com.github.javaparser.ast.Node nodeInClass, String fieldName)
      Finds the field declaration for the given field name in the class of the given node.
      Parameters:
      nodeInClass - the node in the class
      fieldName - the field name
      Returns:
      the field declaration
      Throws:
      IllegalArgumentException - if the field is not found

    • getSetterAndValue

      public static JavaRewriter.SetterAndValue getSetterAndValue(Class<?> componentType, String property, Object value)
      Gets the setter name and value for the given component type, property and value.
      Parameters:
      componentType - the component type
      property - the property
      value - the value
      Returns:
      the setter name and value

    • getSetterName

      public static String getSetterName(String property, Class<?> type, boolean includeReactConversions)
      Gets the setter name for the given property.
      Parameters:
      property - the property
      type - the component type
      includeReactConversions - whether to include React property name conversions in the setter name
      Returns:
      the setter name

    • getPropertyName

      public static String getPropertyName(String setter)
      Gets the camel case property name for the given setter.
      Parameters:
      setter - the setter name
      Returns:
      the property name

    • getFieldOrVariableName

      public static String getFieldOrVariableName(ComponentInfo componentInfo)
      Gets the field or local variable name for the given component.
      Parameters:
      componentInfo - the component info
      Returns:
      the field or local variable name

    • addImport

      public static void addImport(com.github.javaparser.ast.CompilationUnit compilationUnit, String qualifiedName)
      Adds an import to the given compilation unit if it is not already imported.
      Parameters:
      compilationUnit - the compilation unit
      qualifiedName - the qualified name of the import

    • addImport

      public static void addImport(com.github.javaparser.ast.CompilationUnit compilationUnit, String qualifiedName, boolean isStatic, boolean isAsterisk)
      Adds an import to the given compilation unit if it is not already imported.
      Parameters:
      compilationUnit - the compilation unit
      qualifiedName - the qualified name of the import
      isStatic - whether the import is static
      isAsterisk - whether the import end with ".*"

    • getJavaIdentifier

      public static String getJavaIdentifier(String str, int maxLength)
      Converts the given string into a valid Java identifier.
      Parameters:
      str - the string
      maxLength - the maximum length of the identifier, or 0 for unlimited
      Returns:
      the Java identifier

    • hasMethod

      public static boolean hasMethod(Class<?> type, String methodName)
      Checks if the given component type has the given method.
      Parameters:
      type - the component type
      methodName - the method to check for
      Returns:
      true if the component has the method, false otherwise

    • hasSetterForType

      public static boolean hasSetterForType(Class<?> componentType, String setterName, Class<?> valueType)

    • getEnumValue

      public static Enum<?> getEnumValue(Class<?> componentType, String setterName, String value)

    • removeArgumentCalls

      public static void removeArgumentCalls(List<com.github.javaparser.ast.expr.MethodCallExpr> methods, List<? extends com.github.javaparser.ast.expr.Expression> argumentsToRemove, boolean removeMethodIfNoArgs)
      Removes the given arguments from the given method calls.
      Parameters:
      methods - the method calls to process
      argumentsToRemove - the arguments to remove
      removeMethodIfNoArgs - whether to remove the method call if no arguments are left

    • removeArgumentCalls

      public static boolean removeArgumentCalls(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr, List<? extends com.github.javaparser.ast.expr.Expression> argumentsToRemove, boolean removeMethodIfNoArgs)
      Removes the given arguments from the given method call.
      Parameters:
      methodCallExpr - the method call
      argumentsToRemove - the arguments to remove
      removeMethodIfNoArgs - whether to remove the method call if no arguments are left
      Returns:
      true

    • findLocationBefore

      public static InsertionPoint findLocationBefore(com.github.javaparser.ast.Node node)
      Finds the insert location before of given expression.
      Parameters:
      node - Reference node
      Returns:
      Returns code block and index

    • findLocationAfter

      public static InsertionPoint findLocationAfter(com.github.javaparser.ast.Node node)
      Finds the insert location after of given expression.
      Parameters:
      node - Reference node
      Returns:
      the insert location

    • findLocationAtEnd

      public static InsertionPoint findLocationAtEnd(com.github.javaparser.ast.stmt.Statement statement)
      Finds the insert location at the end of the code block containing the given statement.
      Parameters:
      statement - The reference statement
      Returns:
      the insert location

    • addFieldAfter

      public static void addFieldAfter(com.github.javaparser.ast.body.FieldDeclaration newField, com.github.javaparser.ast.body.FieldDeclaration reference)
      Adds a field declaration after the given reference field.
      Parameters:
      newField - the new field declaration
      reference - the reference field

    • clone

      public static <T extends com.github.javaparser.ast.Node> T clone(T node)
      Clones the node in a way that does not mess up the lexical printer.
      Type Parameters:
      T - the type of the node
      Parameters:
      node - the node to clone
      Returns:
      the cloned node

    • getAttachArgument

      public static Optional<com.github.javaparser.ast.expr.Expression> getAttachArgument(ComponentInfo component)
      Finds the attach argument reference of the given component.
      Parameters:
      component - the component
      Returns:
      the attach argument reference, if found

    • getAttachArgumentOrThrow

      public static com.github.javaparser.ast.expr.Expression getAttachArgumentOrThrow(ComponentInfo component)
      Find the attach argument reference of given component or throws IllegalArgumentException if not found.
      Parameters:
      component -
      Returns:
      attach expression

    • setNameExprScope

      public static boolean setNameExprScope(com.github.javaparser.ast.expr.MethodCallExpr newCall, com.github.javaparser.ast.expr.NameExpr nameExpr)
      Sets the name expression scope for the given method call. For a simple call like `foo.setBar()` this changes `foo` and for nested calls like `foo.baz().fo().a().b()` it also changes `foo`.
      Parameters:
      newCall - the method call to change
      nameExpr - the new scope
      Returns:
      true if the scope was changed, false otherwise

    • typesEqual

      public static boolean typesEqual(com.github.javaparser.resolution.types.ResolvedType javaParserType, Class<?> javaReflectionType)
      Checks if the given type is equal to the given reflection type.
      Parameters:
      javaParserType - the Java parser type
      javaReflectionType - the Java reflection type
      Returns:
      true if the types are equal, false otherwise

    • typesEqual

      public static boolean typesEqual(com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration methodDeclaration1, com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration methodDeclaration2)
      Compares two ResolvedMethodDeclaration instances to determine if they are semantically equivalent in terms of their signature and declaring context.
      Parameters:
      methodDeclaration1 - the first method to compare
      methodDeclaration2 - the second method to compare
      Returns:
      true if both methods are considered equal based on the criteria, false otherwise

    • getWrapperDivObjectCreationExpr

      public static com.github.javaparser.ast.expr.ObjectCreationExpr getWrapperDivObjectCreationExpr(com.github.javaparser.ast.CompilationUnit compilationUnit, com.github.javaparser.ast.NodeList<com.github.javaparser.ast.expr.Expression> args)
      Creates a Div creation expression new Div() with given arguments. Given arguments will be cloned and clones will be added to Div constructor.
      Parameters:
      compilationUnit - current compilation unit
      args - Argument expressions
      Returns:
      Div object creation expression

    • isConstructorArgumentFlowComponentType

      public static boolean isConstructorArgumentFlowComponentType(com.github.javaparser.ast.expr.ObjectCreationExpr expr, int argIndex)
      Resolves object creation expression to access Class API to check if given argument in the argIndex exactly equals to com.vaadin.flow.component.Component
      Parameters:
      expr - Object creation expression of a statement e.g. new Div(a,b,c)
      argIndex - Argument to look for. If value exceeds the argument in the constructor, it looks for the last argument
      Returns:
      true if argument class is com.vaadin.flow.component.Component or resolving of the expression fails, false otherwise.

    • constructorArgumentIsArray

      public static boolean constructorArgumentIsArray(com.github.javaparser.ast.expr.ObjectCreationExpr expr, int argIndex)
      Resolves object creation expression to access Class API to get argument.isArray() value of given argument index.
      Parameters:
      expr - Object creation expression of a statement e.g. new Div(a,b,c)
      argIndex - Argument to look for. If value exceeds the argument in the constructor, it looks for the last argument
      Returns:
      true when array is an argument or resolving of expression fails, false otherwise.

    • expressionsInDifferentBlocks

      public static boolean expressionsInDifferentBlocks(com.github.javaparser.ast.expr.Expression expr1, com.github.javaparser.ast.expr.Expression expr2)
      Checks given two expression are in different blocks. If any expression is not a descendant of a method, it returns false.
      Parameters:
      expr1 - first expression
      expr2 - second expression
      Returns:
      true if expressions present in different methods , false otherwise

    • appendExpressionAsNextSiblingInBlockAncestor

      public static boolean appendExpressionAsNextSiblingInBlockAncestor(com.github.javaparser.ast.Node original, com.github.javaparser.ast.stmt.Statement newExpression)
      Appends new expression to original one as sibling in a block statement.
      Parameters:
      original - Original expression
      newExpression - New expression
      Returns:
      true if added, otherwise false.

    • getScopeIgnoreComposite

      public static Optional<com.github.javaparser.ast.expr.Expression> getScopeIgnoreComposite(ComponentInfo componentInfo, com.github.javaparser.ast.expr.MethodCallExpr expr)
      Returns the scope by ignoring the getContent() if component is in a composite container. Otherwise, returns the scope of method.
      • getContent().add(...) returns empty
      • this.getContent().add(...) returns this
      • setSomething() returns empty
      • abc.setSomething() returns abc
      • this.setSomething() returns this
      Parameters:
      componentInfo - Component Info
      expr - Method to get scope
      Returns:
      Scope of the method, empty otherwise.

    • isNodeInCompositeClass

      public static boolean isNodeInCompositeClass(com.github.javaparser.ast.Node node)
      Checks if the given node is a child of a Composite
      Parameters:
      node - Any node in the tree
      Returns:
      true if child of a composite , false otherwise

    • findConstructor

      public static Optional<Constructor<?>> findConstructor(Class<? extends com.vaadin.flow.component.Component> componentType, com.github.javaparser.resolution.Resolvable<com.github.javaparser.resolution.declarations.ResolvedConstructorDeclaration> resolvable)
      Finds constructor for the given component from the constructor that is provided by Resolvable implementation
      Parameters:
      componentType - Component class
      resolvable - Resolvable constructor declaration node
      Returns:
      Constructor if found, empty otherwise.

    • createComponentConstructor

      public static com.github.javaparser.ast.expr.ObjectCreationExpr createComponentConstructor(JavaComponent javaComponent, com.github.javaparser.ast.type.ClassOrInterfaceType componentType, String dataEntityRecordName, Consumer<String> importAdder)
      Creates the convenient component constructor for a new JavaComponent to be added to the code.
      Returns:
      ObjectCreationExpr for Component

    • getSingleStringParamConstructor

      public static Optional<String> getSingleStringParamConstructor(com.github.javaparser.ast.type.ClassOrInterfaceType type, Set<String> setters)
      Returns the single String parameter name from mapped properties of the component that matches an existing single String parameter constructor of the component
      Parameters:
      type - The component type
      setters - The setters of the component
      Returns:
      The name of the property that is the setter of the constructor

    • getMappedProperty

      public static String getMappedProperty(Constructor<?> c, int propertyIndex)
      Returns a property used in a constructor at the given index
      Parameters:
      c - The constructor
      propertyIndex - The index of the property
      Returns:
      The property name

    • containsMethodInEmptyConstructorCall

      public static boolean containsMethodInEmptyConstructorCall(ComponentInfo componentInfo, String methodName)
      Analyzes bytecode of the given component to search for method with methodName is called in an empty constructor
      Parameters:
      componentInfo - Component info to get empty constructor
      methodName - The method name to search for.
      Returns:
      Returns true when method call found in constructor, false when constructor is not found or method is not present

    • generateVariableName

      public static String generateVariableName(JavaComponent javaComponent, com.github.javaparser.ast.type.ClassOrInterfaceType type, InsertionPoint insertionPoint)
      Provides a free name to be used when adding a new component.
      Parameters:
      javaComponent - The JavaComponent to be added
      type - The type of the component
      insertionPoint - The insertion point
      Returns:
      A free variable name

    • regenerateVariableName

      public static String regenerateVariableName(ComponentInfo componentInfo, String newText, String newLabel)
      Regenerates the variable name for the given component.
      Parameters:
      componentInfo - the component to regenerate the variable name for
      newText - the text of the component
      newLabel - the label of the component
      Returns:
      the new variable name

    • functionAffectsVariableName

      public static boolean functionAffectsVariableName(String functionName)
      Checks if the value passed to the given function affects the variable name generated for the component.
      Parameters:
      functionName - the function name
      Returns:
      true if the function affects the variable name, false otherwise

    • isVariableNameAutoGenerated

      public static boolean isVariableNameAutoGenerated(ComponentInfo componentInfo, String currentText, String currentLabel)
      Checks if the given component has a variable name that is auto-generated based on the type/label/text of the component.
      Parameters:
      componentInfo - the component to check
      currentText - the current text of the component
      currentLabel - the current label of the component
      Returns:
      true if the variable name is auto-generated, false otherwise

    • findCalls

      public static List<com.github.javaparser.ast.expr.MethodCallExpr> findCalls(Class<?> classWithMethods, ComponentInfo componentInfo)
      Find all calls done to methods in the given class through a reference to the given component.

      For instance, if you pass in Style.class, then it will find all invocations like button.getStyle().set("color","red"), button.getStyle().setColor("blue") and also Style s = button.getStyle(); s.setColor("black")

      Parameters:
      classWithMethods - the class the check for calls
      componentInfo - the component
      Returns:
      a list of method calls

    • testMethodInClass

      public static Predicate<com.github.javaparser.ast.expr.MethodCallExpr> testMethodInClass(Class<?> classWithMethods, ComponentInfo componentInfo)
      Looks for given method call is a member of given class for the component
      Parameters:
      classWithMethods - Class that where method instance is declared
      componentInfo - Component to look for variable names
      Returns:
      predicate that

    • addFunctionCall

      @Nonnull public static com.github.javaparser.ast.expr.MethodCallExpr addFunctionCall(ComponentInfo componentInfo, String function, List<com.github.javaparser.ast.expr.Expression> parameterExpressions)
      Adds a function call to the given component.
      Parameters:
      componentInfo - the component
      function - the function to call
      parameterExpressions - the parameters to pass to the function

    • getOutermostScope

      public static Optional<com.github.javaparser.ast.expr.Expression> getOutermostScope(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr)
      Gets the outermost scope for a chain of method calls.

      E.g. for foo.bar().baz().qux() it will return foo

      Parameters:
      methodCallExpr - The method call expression
      Returns:
      The outermost scope

    • removeFromChainedStyleCall

      public static void removeFromChainedStyleCall(com.github.javaparser.ast.expr.MethodCallExpr methodCallExpr)
      Removes the given method call from a getStyle call chain.

      If the method call is the only style call, removes the whole statement.

      Parameters:
      methodCallExpr - the method call to remove

    • moveAboveMethodsAndConstructors

      public static void moveAboveMethodsAndConstructors(com.github.javaparser.ast.body.BodyDeclaration<?> toMove, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classOrInterface)

    • createEmptyType

      public static com.github.javaparser.ast.type.Type createEmptyType()
      Creates a Type that can be used in generics to end up with `invalid input: '<'>`.
      Returns:
      an empty type

    • isObjectCreationExprInConstructor

      public static boolean isObjectCreationExprInConstructor(ComponentInfo componentInfo)
      Checks if the given component is created inside the constructor of the class (as opposed to being created in another method).
      Parameters:
      componentInfo - the component
      Returns:
      true if the component is created in the constructor, false otherwise

    • getPropertiesInSourceOrder

      public static List<UIServiceCreator.FieldInfo> getPropertiesInSourceOrder(String itemType) throws IOException
      Parses the given class and finds bean properties in the order they are defined.
      Parameters:
      itemType - the item class name
      Returns:
      a list of property names in the order they are defined in the source
      Throws:
      IOException - if the class file cannot be read

    • getSymbolNameFromJavaParserException

      public static String getSymbolNameFromJavaParserException(com.github.javaparser.resolution.UnsolvedSymbolException e)
      Gets the name of the symbol that could not be resolved.
      Parameters:
      e - the exception from java parser
      Returns:
      the name of the symbol

    • isComponentOrComponentArray

      public static boolean isComponentOrComponentArray(Class<?> type)

    • checkExpressionInLoop

      public static boolean checkExpressionInLoop(com.github.javaparser.ast.expr.Expression expression)
      Checks if given expression is descendant of loop statements. ForStmt, WhileStmt, DoStmt
      Parameters:
      expression - expression to check
      Returns:
      true if loop statements found in ancestor, false otherwise.

    • checkMethodHasExpressionCalledInLoop

      public static boolean checkMethodHasExpressionCalledInLoop(com.github.javaparser.ast.expr.Expression expression)
      Determines whether all invocations of the method containing the given expression are made from within a loop construct (e.g., for, while, or do-while) via checkExpressionInLoop(Expression)
      Parameters:
      expression - the expression located within a method whose calls are to be analyzed
      Returns:
      true if all method calls to the enclosing method are found inside loops; false otherwise or if any step in the process fails

    • findArgumentIndex

      public static int findArgumentIndex(com.github.javaparser.ast.nodeTypes.NodeWithArguments<?> nodeWithArgs, com.github.javaparser.ast.expr.Expression argExpression)
      Iterates arguments to check any of the argument equals to argExpression.
      Parameters:
      nodeWithArgs - node with arguments. e.g. MethodCallExpr, ExplicitConstructorInvocationStmt
      argExpression - expression to check
      Returns:
      argument index or -1 if not found.

    • getVariableNameForAdd

      public static String getVariableNameForAdd(ComponentInfo referenceComponent)

    • createComponentInfoForTemplateComponent

      public static ComponentInfo createComponentInfoForTemplateComponent(JavaSource javaSource, com.github.javaparser.ast.expr.ObjectCreationExpr objectCreationExpr, AttachExpression attachExpression)

    • findReturnStatements

      public static List<com.github.javaparser.ast.stmt.ReturnStmt> findReturnStatements(ComponentInfo componentInfo)
      Find return statements referring to the component.
      Parameters:
      componentInfo - the component to find return statements for
      Returns:
      a list of return statements that refer to the component

    • getMethodIfEmpty

      public static Optional<com.github.javaparser.ast.body.MethodDeclaration> getMethodIfEmpty(com.github.javaparser.ast.stmt.BlockStmt createScope)

    • getAnnotationValue

      public static String getAnnotationValue(com.github.javaparser.ast.expr.AnnotationExpr annotation)
      Gets the value attribute of the given annotation or null if no value is found.
      Parameters:
      annotation - the annotation to check
      Returns:
      the value of the value attribute

    • findIdAnnotatedField

      public static com.github.javaparser.ast.body.FieldDeclaration findIdAnnotatedField(String id, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classType)

    • getQualifiedClassName

      public static Optional<String> getQualifiedClassName(com.github.javaparser.resolution.declarations.ResolvedDeclaration resolvedDeclaration)
      Gets the qualified class name of ResolvedDeclaration when the given declaration is an instance of ResolvedValueDeclaration For generic classes such as Binder, it does not return the generic type instead it would return com.vaadin.flow.data.binder.Binder
      Parameters:
      resolvedDeclaration - Resolved declaration from Resolvable.resolve()
      Returns:
      the qualified class name of the given declaration.