Class StaticTypeCheckingSupport
java.lang.Object
org.codehaus.groovy.transform.stc.StaticTypeCheckingSupport
Support methods for 
StaticTypeCheckingVisitor.- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classA DGM-like class which adds support for method calls which are handled specifically by the Groovy compiler.static class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected static final ClassNodeprotected static final ClassNodeprotected static final ClassNodeprotected static final ClassNodeprotected static final Comparator<MethodNode>This comparator is used when we return the list of methods from DGM which name correspond to a given name.protected static final ExtensionMethodCacheprotected static final ClassNodeprotected static final ClassNodeprotected static final ClassNodeprotected static final ClassNodeprotected static final ClassNodeThis is for internal use only.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic intallParametersAndArgumentsMatch(Parameter[] parameters, ClassNode[] argumentTypes) Determines if the specific argument types fit the parameters.static booleancheckCompatibleAssignmentTypes(ClassNode left, ClassNode right) Returns true or false depending on whether the right classnode can be assigned to the left classnode.static booleancheckCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression) static booleancheckCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression, boolean allowConstructorCoercion) Everything that can be done bycastToTypeshould be allowed for assignment.static List<MethodNode>chooseBestMethod(ClassNode receiver, Collection<MethodNode> methods, ClassNode... argumentTypes) Returns the method(s) which best fit the argument types.static voidstatic voidclearExtensionMethodCache(ClassLoader loader) Deprecated.static ObjectevaluateExpression(Expression expr, CompilerConfiguration config) Deprecated.static ObjectevaluateExpression(Expression expr, CompilerConfiguration config, GroovyClassLoader loader) Evaluates expressions as found in annotation parameters.static List<MethodNode>filterMethodsByVisibility(List<MethodNode> methodNodeList, ClassNode enclosingClassNode) Filter methods according to visibilitystatic List<MethodNode>findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args) static List<MethodNode>findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods) static List<MethodNode>findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args) Deprecated.static List<MethodNode>findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods) Deprecated.static Set<MethodNode>findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name) protected static voidfindDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name, TreeSet<MethodNode> accumulator) protected static Set<MethodNode>findDGMMethodsForClassNode(ClassNode clazz, String name) Deprecated.protected static voidfindDGMMethodsForClassNode(ClassNode clazz, String name, TreeSet<MethodNode> accumulator) Deprecated.static List<MethodNode>findSetters(ClassNode cn, String setterName, boolean voidOnly) protected static VariableGiven a variable expression, returns the ultimately accessed variable.protected static GenericsTypefullyResolve(GenericsType gt, Map<GenericsType.GenericsTypeName, GenericsType> placeholders) Given a generics type representing SomeClass<T,V> and a resolved placeholder map, returns a new generics type for which placeholders are resolved recursively.protected static ClassNodefullyResolveType(ClassNode type, Map<GenericsType.GenericsTypeName, GenericsType> placeholders) static ClassNodegetCorrectedClassNode(ClassNode cn, ClassNode sc, boolean completed) Deprecated.static booleanimplementsInterfaceOrIsSubclassOf(ClassNode type, ClassNode superOrInterface) protected static booleanisArrayAccessExpression(Expression expression) Returns true for expressions of the form x[...]static booleanisAssignableTo(ClassNode type, ClassNode toBeAssignedTo) Checks if a class node is assignable to another.static booleanisAssignment(int op) static booleanisBeingCompiled(ClassNode node) static booleanisClassClassNodeWrappingConcreteType(ClassNode classNode) Returns true if the class node represents a class node for the Class class and if the parametrized type is a neither a placeholder nor a wildcard.static booleanisCompareToBoolean(int op) static booleanstatic booleanstatic booleanstatic ClassNodestatic booleanstatic booleanReturns true if a class makes use of generic types.static booleanReturns true if the provided class node, when considered as a receiver of a message or as a parameter, is using a placeholder in its generics type.static booleanTells if a class is one of the "accept all" classes as the left hand side of an assignment.static booleanisWithCall(String name, Expression arguments) Called on method call checks in order to determine if a method call corresponds to the idiomatic o.with { ...static booleanDetermines if node is a raw type or references any generics placeholders.static Parameter[]parameterizeArguments(ClassNode receiver, MethodNode m) Given a receiver and a method node, parameterize the method arguments using available generic type information.static ClassNoderesolveClassNodeGenerics(Map<GenericsType.GenericsTypeName, GenericsType> resolvedPlaceholders, Map<GenericsType.GenericsTypeName, GenericsType> placeholdersFromContext, ClassNode currentType) protected static booleantypeCheckMethodArgumentWithGenerics(ClassNode parameterType, ClassNode argumentType, boolean lastArg) Checks that the parameterized generics of an argument are compatible with the generics of the parameter.protected static booleantypeCheckMethodsWithGenerics(ClassNode receiver, ClassNode[] argumentTypes, MethodNode candidateMethod) 
- 
Field Details- 
Matcher_TYPE
- 
ArrayList_TYPE
- 
BaseStream_TYPE
- 
Collection_TYPE
- 
Deprecated_TYPE
- 
LinkedHashMap_TYPE
- 
LinkedHashSet_TYPE
- 
NUMBER_TYPES
- 
NUMBER_OPS
- 
GSTRING_STRING_CLASSNODE
- 
UNKNOWN_PARAMETER_TYPEThis is for internal use only. When an argument method is null, we cannot determine its type, so we use this one as a wildcard.
- 
DGM_METHOD_NODE_COMPARATORThis comparator is used when we return the list of methods from DGM which name correspond to a given name. As we also look up for DGM methods of superclasses or interfaces, it may be possible to find two methods which have the same name and the same arguments. In that case, we should not add the method from superclass or interface otherwise the system won't be able to select the correct method, resulting in an ambiguous method selection for similar methods.
- 
EXTENSION_METHOD_CACHE
 
- 
- 
Constructor Details- 
StaticTypeCheckingSupportpublic StaticTypeCheckingSupport()
 
- 
- 
Method Details- 
clearExtensionMethodCachepublic static void clearExtensionMethodCache()
- 
clearExtensionMethodCache
- 
isArrayAccessExpressionReturns true for expressions of the form x[...]- Parameters:
- expression- an expression
- Returns:
- true for array access expressions
 
- 
isWithCallCalled on method call checks in order to determine if a method call corresponds to the idiomatic o.with { ... } structure- Parameters:
- name- name of the method called
- arguments- method call arguments
- Returns:
- true if the name is "with" and arguments consist of a single closure
 
- 
findTargetVariableGiven a variable expression, returns the ultimately accessed variable.- Parameters:
- ve- a variable expression
- Returns:
- the target variable
 
- 
findDGMMethodsForClassNode@Deprecated protected static Set<MethodNode> findDGMMethodsForClassNode(ClassNode clazz, String name) Deprecated.
- 
findDGMMethodsForClassNodepublic static Set<MethodNode> findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name) 
- 
findDGMMethodsForClassNode@Deprecated protected static void findDGMMethodsForClassNode(ClassNode clazz, String name, TreeSet<MethodNode> accumulator) Deprecated.
- 
findDGMMethodsForClassNodeprotected static void findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name, TreeSet<MethodNode> accumulator) 
- 
allParametersAndArgumentsMatchDetermines if the specific argument types fit the parameters.- Returns:
- -1 if arguments do not match, 0 if arguments are of the exact type, and > 0 when one or more argument is not of the exact type but still match
 
- 
isAssignableToChecks if a class node is assignable to another. This is used for example in assignment checks where you want to verify that the assignment is valid.- Returns:
- true if the class node is assignable to the other class node, false otherwise
 
- 
isCompareToBooleanpublic static boolean isCompareToBoolean(int op) 
- 
isAssignmentpublic static boolean isAssignment(int op) 
- 
checkCompatibleAssignmentTypesReturns true or false depending on whether the right classnode can be assigned to the left classnode. This method should not add errors by itself: we let the caller decide what to do if an incompatible assignment is found.- Parameters:
- left- the class to be assigned to
- right- the assignee class
- Returns:
- false if types are incompatible
 
- 
checkCompatibleAssignmentTypespublic static boolean checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression) 
- 
checkCompatibleAssignmentTypespublic static boolean checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression, boolean allowConstructorCoercion) Everything that can be done bycastToTypeshould be allowed for assignment.
- 
isWildcardLeftHandSideTells if a class is one of the "accept all" classes as the left hand side of an assignment.- Parameters:
- node- the classnode to test
- Returns:
- true if it's an Object, String, boolean, Boolean or Class.
 
- 
isBeingCompiled
- 
implementsInterfaceOrIsSubclassOf
- 
findDGMMethodsByNameAndArguments@Deprecated public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args) Deprecated.
- 
findDGMMethodsByNameAndArgumentspublic static List<MethodNode> findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args) 
- 
findDGMMethodsByNameAndArguments@Deprecated public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods) Deprecated.
- 
findDGMMethodsByNameAndArgumentspublic static List<MethodNode> findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods) 
- 
isUsingUncheckedGenericsReturns true if the provided class node, when considered as a receiver of a message or as a parameter, is using a placeholder in its generics type. In this case, we're facing unchecked generics and type checking is limited (ex: void foo(Set s) { s.keySet() }- Parameters:
- node- the node to test
- Returns:
- true if it is using any placeholder in generics types
 
- 
chooseBestMethodpublic static List<MethodNode> chooseBestMethod(ClassNode receiver, Collection<MethodNode> methods, ClassNode... argumentTypes) Returns the method(s) which best fit the argument types.- Returns:
- zero or more results
 
- 
parameterizeArgumentsGiven a receiver and a method node, parameterize the method arguments using available generic type information.- Parameters:
- receiver- the class
- m- the method
- Returns:
- the parameterized arguments
 
- 
isUsingGenericsOrIsArrayUsingGenericsReturns true if a class makes use of generic types. If node represents an array type, then checks if the component type is using generics.- Parameters:
- cn- a class node for which to check if it is using generics
- Returns:
- true if the type (or component type) is using generics
 
- 
fullyResolveprotected static GenericsType fullyResolve(GenericsType gt, Map<GenericsType.GenericsTypeName, GenericsType> placeholders) Given a generics type representing SomeClass<T,V> and a resolved placeholder map, returns a new generics type for which placeholders are resolved recursively.
- 
fullyResolveTypeprotected static ClassNode fullyResolveType(ClassNode type, Map<GenericsType.GenericsTypeName, GenericsType> placeholders) 
- 
typeCheckMethodArgumentWithGenericsprotected static boolean typeCheckMethodArgumentWithGenerics(ClassNode parameterType, ClassNode argumentType, boolean lastArg) Checks that the parameterized generics of an argument are compatible with the generics of the parameter.- Parameters:
- parameterType- the parameter type of a method
- argumentType- the type of the argument passed to the method
 
- 
typeCheckMethodsWithGenericsprotected static boolean typeCheckMethodsWithGenerics(ClassNode receiver, ClassNode[] argumentTypes, MethodNode candidateMethod) 
- 
resolveClassNodeGenericspublic static ClassNode resolveClassNodeGenerics(Map<GenericsType.GenericsTypeName, GenericsType> resolvedPlaceholders, Map<GenericsType.GenericsTypeName, GenericsType> placeholdersFromContext, ClassNode currentType) 
- 
isUnboundedWildcard
- 
filterMethodsByVisibilitypublic static List<MethodNode> filterMethodsByVisibility(List<MethodNode> methodNodeList, ClassNode enclosingClassNode) Filter methods according to visibility- Parameters:
- methodNodeList- method nodes to filter
- enclosingClassNode- the enclosing class
- Returns:
- filtered method nodes
- Since:
- 3.0.0
 
- 
isGStringOrGStringStringLUB- Returns:
- true if the class node is either a GString or the LUB of String and GString.
 
- 
isParameterizedWithGStringOrGStringString- Parameters:
- node- the node to be tested
- Returns:
- true if the node is using generics types and one of those types is a gstring or string/gstring lub
 
- 
isParameterizedWithString- Parameters:
- node- the node to be tested
- Returns:
- true if the node is using generics types and one of those types is a string
 
- 
missesGenericsTypesDetermines if node is a raw type or references any generics placeholders.
- 
evaluateExpressionDeprecated.
- 
evaluateExpressionpublic static Object evaluateExpression(Expression expr, CompilerConfiguration config, GroovyClassLoader loader) Evaluates expressions as found in annotation parameters. For example, it will evaluate a constant, be it referenced directly as an integer or as a reference to a field.If the expression cannot be evaluated on its own, an exception is thrown. - Parameters:
- expr- the expression to be evaluated
- config- the compiler configuration
- loader- the compiler class loader
- Returns:
- the result of the expression
- Throws:
- GroovyBugError
 
- 
collectAllInterfacesDeprecated.Collects all interfaces of a class node, including those defined by the super class.- Parameters:
- node- a class for which we want to retrieve all interfaces
- Returns:
- a set of interfaces implemented by this class node
 
- 
getCorrectedClassNode@Deprecated public static ClassNode getCorrectedClassNode(ClassNode cn, ClassNode sc, boolean completed) Deprecated.
- 
isClassClassNodeWrappingConcreteTypeReturns true if the class node represents a class node for the Class class and if the parametrized type is a neither a placeholder nor a wildcard. For example, the class node Class<Foo> where Foo is a class would return true, but the class node for Class<?> would return false.- Parameters:
- classNode- a class node to be tested
- Returns:
- true if it is the class node for Class and its generic type is a real class
 
- 
findSetters
- 
isTraitSelf
 
- 
evaluateExpression(Expression, CompilerConfiguration, GroovyClassLoader)instead