groovy.lang
[Java] Class GroovyClassLoader

java.lang.Object
  java.lang.ClassLoader
      java.security.SecureClassLoader
          java.net.URLClassLoader
              groovy.lang.GroovyClassLoader

public class GroovyClassLoader
extends java.net.URLClassLoader

A ClassLoader which can load Groovy classes. The loaded classes are cached, classes from other classloaders should not be cached. To be able to load a script that was asked for earlier but was created later it is essential not to keep anything like a "class not found" information for that class name. This includes possible parent loaders. Classes that are not cached are always reloaded.

Authors:

James Strachan

Guillaume Laforge

Steve Goetze

Bing Ran

Scott Stirling

Jochen Theodorou

Version:

\$Revision\$

classCache

protected final java.util.Map classCache

this cache contains the loaded classes or PARSING, if the class is currently parsed

sourceCache

protected final java.util.Map sourceCache

This cache contains mappings of file name to class. It is used to bypass compilation.

GroovyClassLoader

public GroovyClassLoader()

creates a GroovyClassLoader using the current Thread's context Class loader as parent.

GroovyClassLoader

public GroovyClassLoader(java.lang.ClassLoader loader)

creates a GroovyClassLoader using the given ClassLoader as parent

GroovyClassLoader

public GroovyClassLoader(GroovyClassLoader parent)

creates a GroovyClassLoader using the given GroovyClassLoader as parent. This loader will get the parent's CompilerConfiguration

GroovyClassLoader

public GroovyClassLoader(java.lang.ClassLoader parent, CompilerConfiguration config, boolean useConfigurationClasspath)

creates a GroovyClassLoader.

Parameters:

parent - the parent class loader

config - the compiler configuration

useConfigurationClasspath - determines if the configurations classpath should be added

GroovyClassLoader

public GroovyClassLoader(java.lang.ClassLoader loader, CompilerConfiguration config)

creates a GroovyClassLoader using the given ClassLoader as parent.

addClasspath

public void addClasspath(java.lang.String path)

Returns all Groovy classes loaded by this class loader.

Returns:

all classes loaded by this class loader

addURL

public void addURL(java.net.URL url)

clearCache

public void clearCache()

createCollector

protected GroovyClassLoader.ClassCollector createCollector(CompilationUnit unit, SourceUnit su)

createCompilationUnit

protected CompilationUnit createCompilationUnit(CompilerConfiguration config, java.security.CodeSource source)

defineClass

public java.lang.Class defineClass(ClassNode classNode, java.lang.String file, java.lang.String newCodeBase)

Loads the given class node returning the implementation Class.

WARNING: this compilation is not synchronized

Parameters:

classNode

Returns:

a class

defineClass

public java.lang.Class defineClass(java.lang.String name, byte[] b)

generateScriptName

public java.lang.String generateScriptName()

getClassCacheEntry

protected java.lang.Class getClassCacheEntry(java.lang.String name)

getClassPath

protected java.lang.String[] getClassPath()

gets the currently used classpath.

Returns:

a String[] containing the file information of the urls

See Also:

getURLs()

getLoadedClasses

public java.lang.Class[] getLoadedClasses()

getPermissions

protected java.security.PermissionCollection getPermissions(java.security.CodeSource codeSource)

getResourceLoader

public GroovyResourceLoader getResourceLoader()

getTimeStamp

protected long getTimeStamp(java.lang.Class cls)

isRecompilable

protected boolean isRecompilable(java.lang.Class cls)

isShouldRecompile

public java.lang.Boolean isShouldRecompile()

isSourceNewer

protected boolean isSourceNewer(java.net.URL source, java.lang.Class cls)

adds a classpath to this classloader.

Parameters:

path - is a jar file or a directory.

See Also:

addURL(URL)

loadClass

public java.lang.Class loadClass(java.lang.String name, boolean lookupScriptFiles, boolean preferClassOverScript)

loadClass

public java.lang.Class loadClass(java.lang.String name, boolean lookupScriptFiles, boolean preferClassOverScript, boolean resolve)

loadClass

protected long getTimeStamp(Class cls) {
public java.lang.Class loadClass(java.lang.String name)

Implemented here to check package access prior to returning an already loaded class.

throws:

CompilationFailedException if the compilation failed

throws:

ClassNotFoundException if the class was not found

See Also:

java.lang.ClassLoader#loadClass(java.lang.String, boolean)

loadClass

protected java.lang.Class loadClass(java.lang.String name, boolean resolve)

This method will take a file name and try to "decode" any URL encoded characters. For example if the file name contains any spaces this method call will take the resulting %20 encoded values and convert them to spaces.

This method was added specifically to fix defect: Groovy-1787. The defect involved a situation where two scripts were sitting in a directory with spaces in its name. The code would fail when the class loader tried to resolve the file name and would choke on the URLEncoded space values.

parseClass

public java.lang.Class parseClass(java.io.File file)

Parses the given file into a Java class capable of being run

Parameters:

file - the file name to parse

Returns:

the main class defined in the given script

parseClass

public java.lang.Class parseClass(java.lang.String text, java.lang.String fileName)

Parses the given text into a Java class capable of being run

Parameters:

text - the text of the script/class to parse

fileName - the file name to use as the name of the class

Returns:

the main class defined in the given script

parseClass

public java.lang.Class parseClass(java.lang.String text)

Parses the given text into a Java class capable of being run

Parameters:

text - the text of the script/class to parse

Returns:

the main class defined in the given script

parseClass

public java.lang.Class parseClass(java.io.InputStream in, java.lang.String fileName)

deprecated:

Prefer using methods taking a Reader rather than an InputStream to avoid wrong encoding issues.

parseClass

public java.lang.Class parseClass(GroovyCodeSource codeSource)

parseClass

public java.lang.Class parseClass(GroovyCodeSource codeSource, boolean shouldCacheSource)

recompile

protected java.lang.Class recompile(java.net.URL source, java.lang.String className, java.lang.Class oldClass)

(Re)Compiles the given source. This method starts the compilation of a given source, if the source has changed since the class was created. For this isSourceNewer is called.

throws:

CompilationFailedException if the compilation failed

throws:

IOException if the source is not readable

Parameters:

source - the source pointer for the compilation

className - the name of the class to be generated

oldClass - a possible former class

Returns:

the old class if the source wasn't new enough, the new class else

See Also:

isSourceNewer(URL, Class)

removeClassCacheEntry

protected void removeClassCacheEntry(java.lang.String name)

setClassCacheEntry

protected void setClassCacheEntry(java.lang.Class cls)

setResourceLoader

public void setResourceLoader(GroovyResourceLoader resourceLoader)

setShouldRecompile

public void setShouldRecompile(java.lang.Boolean mode)

sets if the recompilation should be enable. There are 3 possible values for this. Any value different than null overrides the value from the compiler configuration. true means to recompile if needed false means to never recompile.

Parameters:

mode - the recompilation mode

See Also:

CompilerConfiguration

Groovy Documentation