public class GenericsUtils extends Object
Utility methods to deal with generic types.
Modifiers | Name | Description |
---|---|---|
static GenericsType[] |
EMPTY_GENERICS_ARRAY |
|
static String |
JAVA_LANG_OBJECT |
Type Params | Return Type | Name and description |
---|---|---|
|
public void |
addError(String msg, ASTNode expr) |
|
public static Map<String, ClassNode> |
addMethodGenerics(MethodNode current, Map<String, ClassNode> oldSpec) |
|
public static GenericsType[] |
alignGenericTypes(GenericsType[] redirectGenericTypes, GenericsType[] parameterizedTypes, GenericsType[] alignmentTarget) Given a parameterized type and a generic type information, aligns actual type parameters. |
|
public static GenericsType[] |
applyGenericsContextToPlaceHolders(Map<String, ClassNode> genericsSpec, GenericsType[] oldPlaceHolders) Transforms generics types from an old context to a new context using the given spec. |
|
public static GenericsType |
buildWildcardType(ClassNode types) Generates a wildcard generic type in order to be used for checks against class nodes. |
|
public static void |
clearParameterizedTypeCache() Clear the parameterized type cache It is useful to IDE as the type being compiled are continuously being edited/altered, see GROOVY-8675 |
|
public static MethodNode |
correctToGenericsSpec(Map<String, ClassNode> genericsSpec, MethodNode mn) |
|
public static ClassNode |
correctToGenericsSpec(Map<String, ClassNode> genericsSpec, GenericsType type) |
|
public static ClassNode |
correctToGenericsSpec(Map<String, ClassNode> genericsSpec, ClassNode type) |
|
public static ClassNode |
correctToGenericsSpecRecurse(Map<String, ClassNode> genericsSpec, ClassNode type) |
|
public static ClassNode[] |
correctToGenericsSpecRecurse(Map<String, ClassNode> genericsSpec, ClassNode[] types)
|
|
public static ClassNode |
correctToGenericsSpecRecurse(Map<String, ClassNode> genericsSpec, ClassNode type, List<String> exclusions) |
|
public static Map<String, ClassNode> |
createGenericsSpec(ClassNode current) |
|
public static Map<String, ClassNode> |
createGenericsSpec(ClassNode current, Map<String, ClassNode> oldSpec) |
|
public static Map<GenericsType.GenericsTypeName, GenericsType> |
extractPlaceholders(ClassNode cn) |
|
public static void |
extractPlaceholders(ClassNode node, Map<GenericsType.GenericsTypeName, GenericsType> map) For a given classnode, fills in the supplied map with the parameterized types it defines. |
|
public static void |
extractSuperClassGenerics(ClassNode type, ClassNode target, Map<String, ClassNode> spec) |
|
public static ClassNode |
findActualTypeByGenericsPlaceholderName(String placeholderName, Map<GenericsType, GenericsType> genericsPlaceholderAndTypeMap) Gets the actual type according to the placeholder name. |
|
public static ClassNode |
findParameterizedType(ClassNode genericsClass, ClassNode actualType) Convenience method for findParameterizedType(ClassNode, ClassNode, boolean) when the tryToFindExactType boolean is false . |
|
public static ClassNode |
findParameterizedType(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType) Get the parameterized type by searching the whole class hierarchy according to generics class and actual receiver. |
|
public static ClassNode |
findParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType) Convenience method for findParameterizedTypeFromCache(ClassNode, ClassNode, boolean) when the tryToFindExactType boolean is false . |
|
public static ClassNode |
findParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType) Try to get the parameterized type from the cache. |
|
public static ClassNode |
getSuperClass(ClassNode type, ClassNode target) |
|
public static boolean |
hasNonPlaceHolders(ClassNode parameterizedType) Check whether the ClassNode has non generics placeholders, aka not placeholder |
|
public static boolean |
hasPlaceHolders(ClassNode parameterizedType) Check whether the ClassNode has generics placeholders |
|
public static ClassNode |
makeClassSafe(Class klass) |
|
public static ClassNode |
makeClassSafe0(ClassNode type, GenericsType genericTypes) |
|
public static ClassNode |
makeClassSafeWithGenerics(Class klass, ClassNode genericsType) |
|
public static ClassNode |
makeClassSafeWithGenerics(ClassNode type, GenericsType genericTypes) |
|
public static Map<GenericsType, GenericsType> |
makeDeclaringAndActualGenericsTypeMap(ClassNode declaringClass, ClassNode actualReceiver) map declaring generics type to actual generics type, e.g. |
|
public static Map<GenericsType, GenericsType> |
makeDeclaringAndActualGenericsTypeMapOfExactType(ClassNode declaringClass, ClassNode actualReceiver) The method is similar with GenericsUtils.makeDeclaringAndActualGenericsTypeMap, The main difference is that the method will try to map all placeholders found to the relevant exact types, but the other will not try even if the parameterized type has placeholders |
|
public static ClassNode |
newClass(ClassNode type) |
|
public static ClassNode |
nonGeneric(ClassNode type) |
|
public static ClassNode |
parameterizeInterfaceGenerics(ClassNode hint, ClassNode target) Interface class nodes retrieved from ClassNode.getInterfaces or ClassNode.getAllInterfaces are returned with generic type arguments. |
|
public static Tuple2<ClassNode, ClassNode> |
parameterizeSAM(ClassNode samType) Gets the parameter and return types of the abstract method of SAM. |
|
public static ClassNode |
parameterizeType(ClassNode hint, ClassNode target) Interface class nodes retrieved from ClassNode.getInterfaces or ClassNode.getAllInterfaces are returned with generic type arguments. |
|
public static ClassNode[] |
parseClassNodesFromString(String option, SourceUnit sourceUnit, CompilationUnit compilationUnit, MethodNode mn, ASTNode usage) |
|
public static String |
toGenericTypesString(GenericsType[] genericsTypes) |
Given a parameterized type and a generic type information, aligns actual type parameters. For example, if a class uses generic type
<T,U,V>(redirectGenericTypes), is used with actual type parameters
<java.lang.String, U,V>, then a class or interface using generic types
<T,V>will be aligned to
<java.lang.String,V>
redirectGenericTypes
- the type arguments or the redirect class nodeparameterizedTypes
- the actual type arguments used on this class nodealignmentTarget
- the generic type arguments to which we want to align toTransforms generics types from an old context to a new context using the given spec. This method assumes all generics types will be placeholders. WARNING: The resulting generics types may or may not be placeholders after the transformation.
genericsSpec
- the generics context information specoldPlaceHolders
- the old placeholdersGenerates a wildcard generic type in order to be used for checks against class nodes. See GenericsType#isCompatibleWith(org.codehaus.groovy.ast.ClassNode).
types
- the type to be used as the wildcard upper boundClear the parameterized type cache It is useful to IDE as the type being compiled are continuously being edited/altered, see GROOVY-8675
For a given classnode, fills in the supplied map with the parameterized types it defines.
node
- the class node to checkmap
- the generics type information collectorGets the actual type according to the placeholder name.
placeholderName
- the placeholder name (i.e. "T", "E", etc.)genericsPlaceholderAndTypeMap
- the result of makeDeclaringAndActualGenericsTypeMap(ClassNode, ClassNode) Convenience method for findParameterizedType(ClassNode, ClassNode, boolean)
when the tryToFindExactType
boolean is false
.
Get the parameterized type by searching the whole class hierarchy according to generics class and actual receiver. findParameterizedTypeFromCache(ClassNode, ClassNode, boolean) is strongly recommended for better performance.
genericsClass
- the generics classactualType
- the actual typetryToFindExactType
- whether to try to find exact type Convenience method for findParameterizedTypeFromCache(ClassNode, ClassNode, boolean)
when the tryToFindExactType
boolean is false
.
Try to get the parameterized type from the cache. If no cached item found, cache and return the result of findParameterizedType(ClassNode, ClassNode, boolean)
Check whether the ClassNode has non generics placeholders, aka not placeholder
parameterizedType
- the class nodeCheck whether the ClassNode has generics placeholders
parameterizedType
- the class nodemap declaring generics type to actual generics type, e.g. GROOVY-7204: declaring generics types: T, S extends Serializable actual generics types : String, Long the result map is [ T: String, S: Long ] The resolved types can not help us to choose methods correctly if the argument is a string: T: Object, S: Serializable so we need actual types: T: String, S: Long
The method is similar with GenericsUtils.makeDeclaringAndActualGenericsTypeMap, The main difference is that the method will try to map all placeholders found to the relevant exact types, but the other will not try even if the parameterized type has placeholders
declaringClass
- the generics class node declaring the generics typesactualReceiver
- the sub-class class nodeInterface class nodes retrieved from ClassNode.getInterfaces or ClassNode.getAllInterfaces are returned with generic type arguments. This method allows returning a parameterized interface given the parameterized class node which implements this interface.
hint
- the class node where generics types are parameterizedtarget
- the interface we want to parameterize generics typesGets the parameter and return types of the abstract method of SAM. If the abstract method is not parameterized, we will get generics placeholders, e.g. T, U For example, the abstract method of Function is
R apply(T t);We parameterize the above interface as
Function<String, Integer>
, then the abstract method will be
Integer apply(String t);When we call
parameterizeSAM
on the ClassNode Function<String, Integer>
,
we can get parameter types and return type of the above abstract method,
i.e. ClassNode ClassHelper.STRING_TYPE
and ClassHelper.Integer_TYPE
samType
- the class node which contains only one abstract methodInterface class nodes retrieved from ClassNode.getInterfaces or ClassNode.getAllInterfaces are returned with generic type arguments. This method allows returning a parameterized interface given the parameterized class node which implements this interface.
hint
- the class node where generics types are parameterizedtarget
- the interface we want to parameterize generics types