Contains static utility methods and constants related to Groovy AST.
This is an internal class and its API is subject to change.Modifiers | Name | Description |
---|---|---|
static List<String> |
AUTO_IMPORTED_CLASSES |
|
static List<String> |
AUTO_IMPORTED_PACKAGES |
|
static List<String> |
COMPARISON_OPERATORS |
Type Params | Return Type | Name and description |
---|---|---|
|
static boolean |
classNodeHasProperty(org.codehaus.groovy.ast.ClassNode classNode, String propertyName) |
|
static boolean |
classNodeImplementsType(org.codehaus.groovy.ast.ClassNode node, Class target) This method tells you if a ClassNode implements or extends a certain class. |
|
static String |
createPrettyExpression(org.codehaus.groovy.ast.ASTNode expression) |
|
static boolean |
expressionIsAssignment(org.codehaus.groovy.ast.ASTNode node, String variableName) |
|
static boolean |
expressionIsNullCheck(org.codehaus.groovy.ast.ASTNode node) |
|
static int |
findFirstNonAnnotationLine(org.codehaus.groovy.ast.ASTNode node, SourceCode sourceCode) gets the first non annotation line number of a node, taking into account annotations. |
|
static org.codehaus.groovy.ast.AnnotationNode |
getAnnotation(org.codehaus.groovy.ast.AnnotatedNode node, String name) Return the AnnotationNode for the named annotation, or else null. |
|
static List<String> |
getArgumentNames(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall) Gets the argument names of a method call. |
|
static String |
getDeclaration(org.codehaus.groovy.ast.ASTNode node, SourceCode sourceCode) |
|
static org.codehaus.groovy.ast.ASTNode |
getEmptyBlock(org.codehaus.groovy.ast.stmt.Statement origStatement) |
|
static Class |
getFieldType(org.codehaus.groovy.ast.ClassNode node, String fieldName) Supports discovering many common JDK types, but not all. |
|
static Class |
getFieldType(org.codehaus.groovy.ast.FieldNode field) Supports discovering many common JDK types, but not all. |
|
static String |
getInstanceOfTarget(Object expression) |
|
static List<? extends org.codehaus.groovy.ast.expr.Expression> |
getMethodArguments(org.codehaus.groovy.ast.ASTNode methodCall) Return the List of Arguments for the specified MethodCallExpression or a ConstructorCallExpression. |
|
static String |
getNodeText(org.codehaus.groovy.ast.ASTNode expression, SourceCode sourceCode) |
|
static String |
getNullComparisonTarget(Object expression) |
|
static List<String> |
getParameterNames(org.codehaus.groovy.ast.MethodNode node) Gets the parameter names of a method node. |
|
static String |
getRawLine(SourceCode sourceCode, int lineNumber) |
|
static List<org.codehaus.groovy.ast.expr.Expression> |
getVariableExpressions(org.codehaus.groovy.ast.expr.DeclarationExpression declarationExpression) Return the List of VariableExpression objects referenced by the specified DeclarationExpression. |
|
static boolean |
hasAnnotation(org.codehaus.groovy.ast.AnnotatedNode node, String name) Return true only if the node has the named annotation |
|
static boolean |
hasAnyAnnotation(org.codehaus.groovy.ast.AnnotatedNode node, String... names) Return true only if the node has any of the named annotations |
|
static boolean |
isBinaryExpressionType(org.codehaus.groovy.ast.expr.Expression expression, String token) Returns true if the expression is a binary expression with the specified token. |
|
static boolean |
isBinaryExpressionType(org.codehaus.groovy.ast.expr.Expression expression, List<String> tokens) Returns true if the expression is a binary expression with the specified token. |
|
static boolean |
isBlock(org.codehaus.groovy.ast.stmt.Statement statement) Return true if the Statement is a block |
|
static boolean |
isBoolean(org.codehaus.groovy.ast.expr.Expression expression) Tells you if the expression is either the true or false literal. |
|
static boolean |
isClosureDeclaration(org.codehaus.groovy.ast.ASTNode expression) Returns true if the ASTNode is a declaration of a closure, either as a declaration or a field. |
|
static boolean |
isConstant(org.codehaus.groovy.ast.expr.Expression expression, Object expected) Tells you if an expression is the expected constant. |
|
static boolean |
isConstantOrConstantLiteral(org.codehaus.groovy.ast.expr.Expression expression) Returns true if an expression is a constant or else a literal that contains only constant values. |
|
static boolean |
isConstantOrLiteral(org.codehaus.groovy.ast.expr.Expression expression) Tells you if an expression is a constant or literal. |
|
static boolean |
isConstructorCall(org.codehaus.groovy.ast.expr.Expression expression, List<String> classNames) Return true if the expression is a constructor call on any of the named classes, with any number of parameters. |
|
static boolean |
isConstructorCall(org.codehaus.groovy.ast.expr.Expression expression, String classNamePattern) Return true if the expression is a constructor call on a class that matches the supplied. |
|
static boolean |
isEmptyBlock(org.codehaus.groovy.ast.stmt.Statement origStatement) Return true if the Statement is a block and it is empty (contains no "meaningful" statements). |
|
static boolean |
isFalse(org.codehaus.groovy.ast.expr.Expression expression) Tells you if the expression is the false expression, either literal or contant. |
|
static boolean |
isFinalVariable(org.codehaus.groovy.ast.expr.DeclarationExpression declarationExpression, SourceCode sourceCode) Return true if the DeclarationExpression represents a 'final' variable declaration. |
|
static boolean |
isFromGeneratedSourceCode(org.codehaus.groovy.ast.ASTNode node) @return true if the ASTNode was generated (synthetic) rather than from the "real" input source code. |
|
static boolean |
isInstanceOfCheck(Object expression) |
|
static boolean |
isListLiteralWithOnlyConstantValues(org.codehaus.groovy.ast.expr.Expression expression) Returns true if a List literal that contains only entries that are constants. |
|
static boolean |
isMapLiteralWithOnlyConstantValues(org.codehaus.groovy.ast.expr.Expression expression) Returns true if a Map literal that contains only entries where both key and value are constants. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.stmt.Statement stmt, String methodObject, String methodName, int numArguments) Return true only if the Statement represents a method call for the specified method object (receiver), method name, and with the specified number of arguments. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall, String methodObjectPattern, String methodPattern, int numArguments) Return true only if the MethodCallExpression represents a method call for the specified method object (receiver), method name, and with the specified number of arguments. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.Expression expression, String methodObject, String methodName, int numArguments) Return true only if the expression is a MethodCallExpression representing a method call for the specified method object (receiver), method name, and with the specified number of arguments. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.Expression expression, String methodObjectPattern, String methodNamePattern) Return true only if the expression represents a method call (MethodCallExpression) for the specified method object (receiver) and method name. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall, List<String> methodObjects, List<String> methodNames, Integer numArguments) Return true only if the MethodCallExpression represents a method call for any one of the specified method objects (receivers) and any one of the method names. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall, List<String> methodObjects, List<String> methodNames) |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.Expression expression, String methodName, int numArguments) Tells you if the expression is a method call for a certain method name with a certain number of arguments. |
|
static boolean |
isMethodCall(org.codehaus.groovy.ast.expr.Expression expression, String methodName, groovy.lang.Range numArguments) Tells you if the expression is a method call for a certain method name with a certain number of arguments. |
|
static boolean |
isMethodCallOnObject(org.codehaus.groovy.ast.expr.Expression expression, String methodObjectPattern) Tells you if the expression is a method call on a particular object (which is represented as a String). |
|
static boolean |
isMethodNamed(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall, String methodNamePattern, Integer numArguments) Return true only if the MethodCallExpression represents a method call for the specified method name |
|
static boolean |
isMethodNamed(org.codehaus.groovy.ast.expr.MethodCallExpression methodCall, String methodNamePattern) |
|
static boolean |
isMethodNode(org.codehaus.groovy.ast.ASTNode node, String methodNamePattern, Integer numArguments, Class returnType) Tells you if the ASTNode is a method node for the given name, arity, and return type. |
|
static boolean |
isMethodNode(org.codehaus.groovy.ast.ASTNode node, String methodNamePattern, Integer numArguments) |
|
static boolean |
isMethodNode(org.codehaus.groovy.ast.ASTNode node, String methodNamePattern) |
|
static boolean |
isNotNullCheck(Object expression) |
|
static boolean |
isNull(org.codehaus.groovy.ast.ASTNode expression) Tells you if the expression is the null literal. |
|
static boolean |
isNullCheck(Object expression) |
|
static boolean |
isOneLiner(Object statement) |
|
static boolean |
isPropertyNamed(org.codehaus.groovy.ast.expr.Expression property, Object expectedName) |
|
static boolean |
isPublic(org.codehaus.groovy.ast.ASTNode node) Tells you if the ASTNode has a public modifier on it. |
|
static boolean |
isSafe(org.codehaus.groovy.ast.expr.Expression expression) Tells you if the expression is a null safe dereference. |
|
static boolean |
isSpreadSafe(org.codehaus.groovy.ast.expr.Expression expression) Tells you if the expression is a spread operator call |
|
static boolean |
isSuperReference(org.codehaus.groovy.ast.expr.Expression expression) |
|
static boolean |
isThisReference(org.codehaus.groovy.ast.expr.Expression expression) |
|
static boolean |
isTrue(org.codehaus.groovy.ast.expr.Expression expression) Tells you if the expression is true, which can be true or Boolean.TRUE. |
|
static boolean |
isVariable(org.codehaus.groovy.ast.ASTNode expression, String pattern) Tells you if the given ASTNode is a VariableExpression with the given name. |
|
static boolean |
respondsTo(Object object, String methodName) Return true only if the specified object responds to the named method |
This method tells you if a ClassNode implements or extends a certain class.
node
- the nodetarget
- the classgets the first non annotation line number of a node, taking into account annotations.
Return the AnnotationNode for the named annotation, or else null. Supports Groovy 1.5 and Groovy 1.6.
node
- - the AnnotatedNodename
- - the name of the annotationGets the argument names of a method call. If the arguments are not VariableExpressions then a null will be returned.
methodCall
- the method call to searchSupports discovering many common JDK types, but not all.
Supports discovering many common JDK types, but not all.
Return the List of Arguments for the specified MethodCallExpression or a ConstructorCallExpression. The returned List contains either ConstantExpression or MapEntryExpression objects.
methodCall
- - the AST MethodCallExpression or ConstructorCalLExpressionGets the parameter names of a method node.
node
- the node to search parameter names onReturn the List of VariableExpression objects referenced by the specified DeclarationExpression.
declarationExpression
- - the DeclarationExpressionReturn true only if the node has the named annotation
node
- - the AST Node to checkname
- - the name of the annotationReturn true only if the node has any of the named annotations
node
- - the AST Node to checknames
- - the names of the annotationsReturns true if the expression is a binary expression with the specified token.
expression
- expressiontoken
- tokenReturns true if the expression is a binary expression with the specified token.
expression
- - the expression nodetokens
- - the List of allowable (operator) tokensReturn true if the Statement is a block
statement
- - the Statement to checkTells you if the expression is either the true or false literal.
expression
- expressionReturns true if the ASTNode is a declaration of a closure, either as a declaration or a field.
expression
- the target expressionTells you if an expression is the expected constant.
expression
- any expressionexpected
- the expected int or StringReturns true if an expression is a constant or else a literal that contains only constant values. Basically, is it a constant, or else a map like [a:1, b:99, c:true], or a list like ['abc', 99.0, false]
expression
- - any expressionTells you if an expression is a constant or literal. Basically, is it a map, list, constant, or a predefined constant like true/false.
expression
- any expressionReturn true if the expression is a constructor call on any of the named classes, with any number of parameters.
expression
- - the expressionclassNames
- - the possible List of class namesReturn true if the expression is a constructor call on a class that matches the supplied.
expression
- - the expressionclassNamePattern
- - the possible List of class namesReturn true if the Statement is a block and it is empty (contains no "meaningful" statements). This implementation also addresses some "weirdness" around some statement types (specifically finally) where the BlockStatement answered false to isEmpty() even if it was.
origStatement
- - the Statement to checkTells you if the expression is the false expression, either literal or contant.
expression
- expressionReturn true if the DeclarationExpression represents a 'final' variable declaration. NOTE: THIS IS A WORKAROUND. There does not seem to be an easy way to determine whether the 'final' modifier has been specified for a variable declaration. Return true if the 'final' is present before the variable name.
Returns true if a List literal that contains only entries that are constants.
expression
- - any expressionReturns true if a Map literal that contains only entries where both key and value are constants.
expression
- - any expressionReturn true only if the Statement represents a method call for the specified method object (receiver), method name, and with the specified number of arguments.
stmt
- - the AST StatementmethodObject
- - the name of the method object (receiver)methodName
- - the name of the method being callednumArguments
- - the number of arguments passed into the methodReturn true only if the MethodCallExpression represents a method call for the specified method object (receiver), method name, and with the specified number of arguments.
methodCall
- - the AST MethodCallExpressionmethodObjectPattern
- - the name of the method object (receiver)methodPattern
- - the name of the method being callednumArguments
- - the number of arguments passed into the methodReturn true only if the expression is a MethodCallExpression representing a method call for the specified method object (receiver), method name, and with the specified number of arguments.
expression
- - the AST expressionmethodObject
- - the name of the method object (receiver)methodName
- - the name of the method being callednumArguments
- - the number of arguments passed into the methodReturn true only if the expression represents a method call (MethodCallExpression) for the specified method object (receiver) and method name.
expression
- - the AST expression to be checkedmethodObjectPattern
- - the name of the method object (receiver)methodNamePattern
- - the name of the method being calledReturn true only if the MethodCallExpression represents a method call for any one of the specified method objects (receivers) and any one of the method names. Optionally, you can restrict it to a method call with a certain number of arguments.
methodCall
- the method call objectmethodObjects
- a list of receivers, such as ['this', 'super']methodNames
- a list of method namesnumArguments
- optionally, require a certain number of argumentsTells you if the expression is a method call for a certain method name with a certain number of arguments.
expression
- the (potentially) method callmethodName
- the name of the method expectednumArguments
- number of expected argumentsTells you if the expression is a method call for a certain method name with a certain number of arguments.
expression
- the (potentially) method callmethodName
- the name of the method expectednumArguments
- number of expected argumentsTells you if the expression is a method call on a particular object (which is represented as a String). For instance, you may ask isMethodCallOnObject(e, 'this') to find a this reference.
expression
- - the expressionmethodObjectPattern
- - the name of the method object (receiver) such as 'this'Return true only if the MethodCallExpression represents a method call for the specified method name
methodCall
- - the AST MethodCallExpressionmethodNamePattern
- - the expected name of the method being callednumArguments
- - The number of expected argumentsTells you if the ASTNode is a method node for the given name, arity, and return type.
node
- the node to inspectmethodNamePattern
- the expected name of the methodnumArguments
- the expected number of arguments, optionalreturnType
- the expected return type, optionalTells you if the expression is the null literal.
expression
- expression.Tells you if the ASTNode has a public modifier on it. If the node does not have modifiers at all (like a variable expression) then false is returned.
node
- node to queryTells you if the expression is a null safe dereference.
expression
- expressionTells you if the expression is a spread operator call
expression
- expressionTells you if the expression is true, which can be true or Boolean.TRUE.
expression
- expressionTells you if the given ASTNode is a VariableExpression with the given name.
expression
- any AST Nodepattern
- a string pattern to match