Package org.codehaus.groovy.ast.tools
Class GenericsUtils
- java.lang.Object
- 
- org.codehaus.groovy.ast.tools.GenericsUtils
 
- 
 public class GenericsUtils extends Object Utility methods to deal with generic types.
- 
- 
Field SummaryFields Modifier and Type Field Description static GenericsType[]EMPTY_GENERICS_ARRAYstatic StringJAVA_LANG_OBJECT
 - 
Constructor SummaryConstructors Constructor Description GenericsUtils()
 - 
Method SummaryAll Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Map<String,ClassNode>addMethodGenerics(MethodNode current, Map<String,ClassNode> oldSpec)static GenericsType[]alignGenericTypes(GenericsType[] redirectGenericTypes, GenericsType[] parameterizedTypes, GenericsType[] alignmentTarget)Deprecated.You shouldn't call this method because it is inherently unreliablestatic GenericsType[]applyGenericsContextToPlaceHolders(Map<String,ClassNode> genericsSpec, GenericsType[] oldPlaceHolders)Transforms generics types from an old context to a new context using the given spec.static GenericsTypebuildWildcardType(ClassNode... types)Generates a wildcard generic type in order to be used for checks against class nodes.static voidclearParameterizedTypeCache()Clears the parameterized type cache.static ClassNodecorrectToGenericsSpec(Map<String,ClassNode> genericsSpec, ClassNode type)static ClassNodecorrectToGenericsSpec(Map<String,ClassNode> genericsSpec, GenericsType type)static MethodNodecorrectToGenericsSpec(Map<String,ClassNode> genericsSpec, MethodNode mn)static ClassNodecorrectToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode type)static ClassNode[]correctToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode[] types)static ClassNodecorrectToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode type, List<String> exclusions)static Map<String,ClassNode>createGenericsSpec(ClassNode current)static Map<String,ClassNode>createGenericsSpec(ClassNode current, Map<String,ClassNode> oldSpec)static Map<GenericsType.GenericsTypeName,GenericsType>extractPlaceholders(ClassNode cn)static voidextractPlaceholders(ClassNode node, Map<GenericsType.GenericsTypeName,GenericsType> map)For a given classnode, fills in the supplied map with the parameterized types it defines.static voidextractSuperClassGenerics(ClassNode type, ClassNode target, Map<String,ClassNode> spec)static ClassNodefindActualTypeByGenericsPlaceholderName(String placeholderName, Map<GenericsType,GenericsType> genericsPlaceholderAndTypeMap)Gets the actual type according to the placeholder name.static ClassNodefindParameterizedType(ClassNode genericsClass, ClassNode actualType)Convenience method forfindParameterizedType(ClassNode,ClassNode,boolean)whentryToFindExactTypeisfalse.static ClassNodefindParameterizedType(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType)Gets the parameterized type by searching the whole class hierarchy according to generics class and actual receiver.static ClassNodefindParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType)Convenience method forfindParameterizedTypeFromCache(ClassNode, ClassNode, boolean)when thetryToFindExactTypeboolean isfalse.static ClassNodefindParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType)Try to get the parameterized type from the cache.static ClassNodegetSuperClass(ClassNode type, ClassNode target)static booleanhasNonPlaceHolders(ClassNode type)Checks if the type has any non-placeholder (aka resolved) generics.static booleanhasPlaceHolders(ClassNode type)Checks if the type has any placeholder (aka unresolved) generics.static booleanhasUnresolvedGenerics(ClassNode type)Checks for any placeholder (aka unresolved) generics.static ClassNodemakeClassSafe(Class klass)static ClassNodemakeClassSafe0(ClassNode type, GenericsType... genericTypes)static ClassNodemakeClassSafeWithGenerics(Class klass, ClassNode genericsType)static ClassNodemakeClassSafeWithGenerics(ClassNode type, GenericsType... genericTypes)static Map<GenericsType,GenericsType>makeDeclaringAndActualGenericsTypeMap(ClassNode declaringClass, ClassNode actualReceiver)map declaring generics type to actual generics type, e.g.static Map<GenericsType,GenericsType>makeDeclaringAndActualGenericsTypeMapOfExactType(ClassNode declaringClass, ClassNode actualReceiver)The method is similar withmakeDeclaringAndActualGenericsTypeMap(ClassNode, ClassNode), 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 placeholdersstatic ClassNodenewClass(ClassNode type)static ClassNodenonGeneric(ClassNode type)static ClassNodeparameterizeInterfaceGenerics(ClassNode hint, ClassNode target)Deprecated.Use #parameterizeType insteadstatic Tuple2<ClassNode[],ClassNode>parameterizeSAM(ClassNode samType)Gets the parameter and return types of the abstract method of SAM.static ClassNodeparameterizeType(ClassNode hint, ClassNode target)Interface class nodes retrieved fromClassNode.getInterfaces()orClassNode.getAllInterfaces()are returned with generic type arguments.static ClassNode[]parseClassNodesFromString(String option, SourceUnit sourceUnit, CompilationUnit compilationUnit, MethodNode mn, ASTNode usage)static StringtoGenericTypesString(GenericsType[] genericsTypes)
 
- 
- 
- 
Field Detail- 
EMPTY_GENERICS_ARRAYpublic static final GenericsType[] EMPTY_GENERICS_ARRAY 
 - 
JAVA_LANG_OBJECTpublic static final String JAVA_LANG_OBJECT - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
alignGenericTypes@Deprecated public static GenericsType[] alignGenericTypes(GenericsType[] redirectGenericTypes, GenericsType[] parameterizedTypes, GenericsType[] alignmentTarget) Deprecated.You shouldn't call this method because it is inherently unreliableGiven 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> - Parameters:
- redirectGenericTypes- the type arguments or the redirect class node
- parameterizedTypes- the actual type arguments used on this class node
- alignmentTarget- the generic type arguments to which we want to align to
- Returns:
- aligned type arguments
 
 - 
buildWildcardTypepublic static GenericsType buildWildcardType(ClassNode... types) Generates a wildcard generic type in order to be used for checks against class nodes. SeeGenericsType.isCompatibleWith(org.codehaus.groovy.ast.ClassNode).- Parameters:
- types- the type to be used as the wildcard upper bound
- Returns:
- a wildcard generics type
 
 - 
extractPlaceholderspublic static Map<GenericsType.GenericsTypeName,GenericsType> extractPlaceholders(ClassNode cn) 
 - 
extractPlaceholderspublic 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.- Parameters:
- node- the class node to check
- map- the generics type information collector
 
 - 
toGenericTypesStringpublic static String toGenericTypesString(GenericsType[] genericsTypes) 
 - 
parameterizeInterfaceGenerics@Deprecated public static ClassNode parameterizeInterfaceGenerics(ClassNode hint, ClassNode target) Deprecated.Use #parameterizeType insteadInterface class nodes retrieved fromClassNode.getInterfaces()orClassNode.getAllInterfaces()are returned with generic type arguments. This method allows returning a parameterized interface given the parameterized class node which implements this interface.- Parameters:
- hint- the class node where generics types are parameterized
- target- the interface we want to parameterize generics types
- Returns:
- a parameterized interface class node
 
 - 
parameterizeTypepublic static ClassNode parameterizeType(ClassNode hint, ClassNode target) Interface class nodes retrieved fromClassNode.getInterfaces()orClassNode.getAllInterfaces()are returned with generic type arguments. This method allows returning a parameterized interface given the parameterized class node which implements this interface.- Parameters:
- hint- the class node where generics types are parameterized
- target- the interface we want to parameterize generics types
- Returns:
- a parameterized interface class node
 
 - 
makeClassSafeWithGenericspublic static ClassNode makeClassSafeWithGenerics(Class klass, ClassNode genericsType) 
 - 
makeClassSafe0public static ClassNode makeClassSafe0(ClassNode type, GenericsType... genericTypes) 
 - 
makeClassSafeWithGenericspublic static ClassNode makeClassSafeWithGenerics(ClassNode type, GenericsType... genericTypes) 
 - 
correctToGenericsSpecpublic static MethodNode correctToGenericsSpec(Map<String,ClassNode> genericsSpec, MethodNode mn) 
 - 
correctToGenericsSpecRecursepublic static ClassNode correctToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode type) 
 - 
correctToGenericsSpecRecursepublic static ClassNode[] correctToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode[] types) - Since:
- 2.4.1
 
 - 
correctToGenericsSpecRecursepublic static ClassNode correctToGenericsSpecRecurse(Map<String,ClassNode> genericsSpec, ClassNode type, List<String> exclusions) 
 - 
correctToGenericsSpecpublic static ClassNode correctToGenericsSpec(Map<String,ClassNode> genericsSpec, GenericsType type) 
 - 
correctToGenericsSpecpublic static ClassNode correctToGenericsSpec(Map<String,ClassNode> genericsSpec, ClassNode type) 
 - 
createGenericsSpecpublic static Map<String,ClassNode> createGenericsSpec(ClassNode current, Map<String,ClassNode> oldSpec) 
 - 
addMethodGenericspublic static Map<String,ClassNode> addMethodGenerics(MethodNode current, Map<String,ClassNode> oldSpec) 
 - 
extractSuperClassGenericspublic static void extractSuperClassGenerics(ClassNode type, ClassNode target, Map<String,ClassNode> spec) 
 - 
parseClassNodesFromStringpublic static ClassNode[] parseClassNodesFromString(String option, SourceUnit sourceUnit, CompilationUnit compilationUnit, MethodNode mn, ASTNode usage) 
 - 
applyGenericsContextToPlaceHolderspublic static GenericsType[] applyGenericsContextToPlaceHolders(Map<String,ClassNode> genericsSpec, GenericsType[] oldPlaceHolders) Transforms 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.- Parameters:
- genericsSpec- the generics context information spec
- oldPlaceHolders- the old placeholders
- Returns:
- the new generics types
 
 - 
findParameterizedTypeFromCachepublic static ClassNode findParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType) Convenience method forfindParameterizedTypeFromCache(ClassNode, ClassNode, boolean)when thetryToFindExactTypeboolean isfalse.
 - 
findParameterizedTypeFromCachepublic static ClassNode findParameterizedTypeFromCache(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType) Try to get the parameterized type from the cache.If no cached item found, cache and return the result of findParameterizedType(ClassNode,ClassNode,boolean)
 - 
findParameterizedTypepublic static ClassNode findParameterizedType(ClassNode genericsClass, ClassNode actualType) Convenience method forfindParameterizedType(ClassNode,ClassNode,boolean)whentryToFindExactTypeisfalse.
 - 
findParameterizedTypepublic static ClassNode findParameterizedType(ClassNode genericsClass, ClassNode actualType, boolean tryToFindExactType) Gets 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.
 - 
clearParameterizedTypeCachepublic static void clearParameterizedTypeCache() Clears the parameterized type cache.It is useful to IDE as the type being compiled are continuously being edited/altered, see GROOVY-8675 
 - 
makeDeclaringAndActualGenericsTypeMappublic static Map<GenericsType,GenericsType> makeDeclaringAndActualGenericsTypeMap(ClassNode declaringClass, ClassNode actualReceiver) map 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
 - 
makeDeclaringAndActualGenericsTypeMapOfExactTypepublic static Map<GenericsType,GenericsType> makeDeclaringAndActualGenericsTypeMapOfExactType(ClassNode declaringClass, ClassNode actualReceiver) The method is similar withmakeDeclaringAndActualGenericsTypeMap(ClassNode, ClassNode), 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- Parameters:
- declaringClass- the generics class node declaring the generics types
- actualReceiver- the sub-class class node
- Returns:
- the placeholder-to-actualtype mapping
- Since:
- 3.0.0
 
 - 
hasNonPlaceHolderspublic static boolean hasNonPlaceHolders(ClassNode type) Checks if the type has any non-placeholder (aka resolved) generics.- Since:
- 3.0.0
 
 - 
hasPlaceHolderspublic static boolean hasPlaceHolders(ClassNode type) Checks if the type has any placeholder (aka unresolved) generics.- Since:
- 3.0.0
 
 - 
hasUnresolvedGenericspublic static boolean hasUnresolvedGenerics(ClassNode type) Checks for any placeholder (aka unresolved) generics.
 - 
parameterizeSAMpublic static Tuple2<ClassNode[],ClassNode> parameterizeSAM(ClassNode samType) Gets 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 ofFunctionisR apply(T t);We parameterize the above interface asFunction<String, Integer>, then the abstract method will beInteger apply(String t);When we callparameterizeSAMon the ClassNodeFunction<String, Integer>, we can get parameter types and return type of the above abstract method, i.e. ClassNodeClassHelper.STRING_TYPEandClassHelper.Integer_TYPE- Parameters:
- samType- the class node which contains only one abstract method
- Since:
- 3.0.0
 
 - 
findActualTypeByGenericsPlaceholderNamepublic static ClassNode findActualTypeByGenericsPlaceholderName(String placeholderName, Map<GenericsType,GenericsType> genericsPlaceholderAndTypeMap) Gets the actual type according to the placeholder name.- Parameters:
- placeholderName- the placeholder name (i.e. "T", "E", etc.)
- genericsPlaceholderAndTypeMap- the result of- makeDeclaringAndActualGenericsTypeMap(ClassNode, ClassNode)
 
 
- 
 
-