Package org.codehaus.groovy.control
Class ClassNodeResolver
- java.lang.Object
- 
- org.codehaus.groovy.control.ClassNodeResolver
 
- 
 public class ClassNodeResolver extends java.lang.ObjectThis class is used as a pluggable way to resolve class names. An instance of this class has to be added toCompilationUnitusingCompilationUnit.setClassNodeResolver(ClassNodeResolver). The CompilationUnit will then set the resolver on theResolveVisitoreach time new. The ResolveVisitor will prepare name lookup and then finally ask the resolver if the class exists. This resolver then can return either a SourceUnit or a ClassNode. In case of a SourceUnit the compiler is notified that a new source is to be added to the compilation queue. In case of a ClassNode no further action than the resolving is done. The lookup result is stored in the helper classClassNodeResolver.LookupResult. This class provides a class cache to cache lookups. If you don't want this, you have to override the methodscacheClass(String, ClassNode)andgetFromClassCache(String). Custom lookup logic is supposed to go into the methodfindClassNode(String, CompilationUnit)while the entry method isresolveName(String, CompilationUnit)
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classClassNodeResolver.LookupResultHelper class to return either a SourceUnit or ClassNode.
 - 
Constructor SummaryConstructors Constructor Description ClassNodeResolver()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcacheClass(java.lang.String name, ClassNode res)caches a ClassNodeClassNodeResolver.LookupResultfindClassNode(java.lang.String name, CompilationUnit compilationUnit)Extension point for custom lookup logic of finding ClassNodes.ClassNodegetFromClassCache(java.lang.String name)returns whatever is stored in the class cache for the given nameClassNodeResolver.LookupResultresolveName(java.lang.String name, CompilationUnit compilationUnit)Resolves the name of a class to a SourceUnit or ClassNode.
 
- 
- 
- 
Field Detail- 
NO_CLASSprotected static final ClassNode NO_CLASS Internal helper used to indicate a cache hit for a class that does not exist. This way further lookups through a slowfindClassNode(String, CompilationUnit)path can be avoided. WARNING: This class is not to be used outside of ClassNodeResolver.
 
- 
 - 
Method Detail- 
resolveNamepublic ClassNodeResolver.LookupResult resolveName(java.lang.String name, CompilationUnit compilationUnit) Resolves the name of a class to a SourceUnit or ClassNode. If no class or source is found this method returns null. A lookup is done by first asking the cache if there is an entry for the class already available to then callfindClassNode(String, CompilationUnit). The result of that method call will be cached if a ClassNode is found. If a SourceUnit is found, this method will not be asked later on again for that class, because ResolveVisitor will first ask the CompilationUnit for classes in the compilation queue and it will find the class for that SourceUnit there then. method return a ClassNode instead of a SourceUnit, the res- Parameters:
- name- - the name of the class
- compilationUnit- - the current CompilationUnit
- Returns:
- the LookupResult
 
 - 
cacheClasspublic void cacheClass(java.lang.String name, ClassNode res)caches a ClassNode- Parameters:
- name- - the name of the class
- res- - the ClassNode for that name
 
 - 
getFromClassCachepublic ClassNode getFromClassCache(java.lang.String name) returns whatever is stored in the class cache for the given name- Parameters:
- name- - the name of the class
- Returns:
- the result of the lookup, which may be null
 
 - 
findClassNodepublic ClassNodeResolver.LookupResult findClassNode(java.lang.String name, CompilationUnit compilationUnit) Extension point for custom lookup logic of finding ClassNodes. Per default this will use the CompilationUnit class loader to do a lookup on the class path and load the needed class using that loader. Or if a script is found and that script is seen as "newer", the script will be used instead of the class.- Parameters:
- name- - the name of the class
- compilationUnit- - the current compilation unit
- Returns:
- the lookup result
 
 
- 
 
-