Class JavaSourceClassLoader

java.lang.Object

java.lang.ClassLoader

org.codehaus.commons.compiler.AbstractJavaSourceClassLoader

org.codehaus.commons.compiler.jdk.JavaSourceClassLoader

public class JavaSourceClassLoader
extends AbstractJavaSourceClassLoader

A ClassLoader that loads classes by looking for their source files through a "source path" and compiling them on-the-fly.

Notice that this class loader does not support resoures in the sense of ClassLoader.getResource(String), ClassLoader.getResourceAsStream(String) nd ClassLoader.getResources(String).

See Also:

• ClassLoaders

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaSourceClassLoader.DiagnosticException	Container for a Diagnostic object.

Nested classes/interfaces inherited from class AbstractJavaSourceClassLoader

AbstractJavaSourceClassLoader.ProtectionDomainFactory

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<String>	compilerOptions
private boolean	debuggingInfoLines
private boolean	debuggingInfoSource
private boolean	debuggingInfoVars
private JavaFileManager	fileManager
private Charset	sourceCharset
private ResourceFinder	sourceFinder
private static final JavaCompiler	SYSTEM_JAVA_COMPILER

Fields inherited from class AbstractJavaSourceClassLoader

protectionDomainFactory

Constructor Summary

Constructors

Constructor	Description
JavaSourceClassLoader()
JavaSourceClassLoader(ClassLoader parentClassLoader)

Method Summary

Modifier and Type	Method	Description
protected Class<?>	findClass(String className)	Implementation of ClassLoader.findClass(String).
private Class<?>	findClass2(String className)
private JavaFileObject	findClassFile(String className)
private JavaFileManager	getJavaFileManager()	Creates the underlying JavaFileManager lazily, because setSourcePath(File[]) and consorts are called after initialization.
private static String	getSourceResourceName(String className)	Constructs the name of a resource that could contain the source code of the class with the given name.
private static JavaCompiler	getSystemJavaCompiler()
private void	init()
void	setCompilerOptions(String[] compilerOptions)	Notice: Don't use the '-g' options - these are controlled through setDebuggingInfo(boolean, boolean, boolean).
void	setDebuggingInfo(boolean lines, boolean vars, boolean source)
void	setSourceCharset(Charset charset)
void	setSourceFinder(ResourceFinder sourceFinder)
void	setSourcePath(File[] sourcePath)

Methods inherited from class AbstractJavaSourceClassLoader

getResourceAsStream, main, setProtectionDomainFactory, setSourceFileCharacterEncoding

Methods inherited from class ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findResource, findResources, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SYSTEM_JAVA_COMPILER

private static final JavaCompiler SYSTEM_JAVA_COMPILER

sourceFinder

private ResourceFinder sourceFinder

sourceCharset

private Charset sourceCharset

debuggingInfoLines

private boolean debuggingInfoLines

debuggingInfoVars

private boolean debuggingInfoVars

debuggingInfoSource

private boolean debuggingInfoSource

compilerOptions

private Collection<String> compilerOptions

fileManager

@Nullable
private JavaFileManager fileManager

Constructor Details

JavaSourceClassLoader

public JavaSourceClassLoader()

See Also:

• ICompilerFactory.newJavaSourceClassLoader()

JavaSourceClassLoader

public JavaSourceClassLoader(ClassLoader parentClassLoader)

See Also:

• ICompilerFactory.newJavaSourceClassLoader(ClassLoader)

Method Details

getSystemJavaCompiler

private static JavaCompiler getSystemJavaCompiler()

init

private void init()

getJavaFileManager

private JavaFileManager getJavaFileManager()

Creates the underlying JavaFileManager lazily, because setSourcePath(File[]) and consorts are called after initialization.

setSourcePath

public void setSourcePath(File[] sourcePath)

Specified by:

setSourcePath in class AbstractJavaSourceClassLoader

Parameters:

sourcePath - The sequence of directories to search for Java source files

setSourceFinder

public void setSourceFinder(ResourceFinder sourceFinder)

Specified by:

setSourceFinder in class AbstractJavaSourceClassLoader

Parameters:

sourceFinder - Is used when searching for Java source files

setSourceCharset

public void setSourceCharset(Charset charset)

Specified by:

setSourceCharset in class AbstractJavaSourceClassLoader

Parameters:

charset - The character set to using when reading characters from a source file

setDebuggingInfo

public void setDebuggingInfo(boolean lines,
 boolean vars,
 boolean source)

Specified by:

setDebuggingInfo in class AbstractJavaSourceClassLoader

Parameters:

lines - Whether line number debugging information should be generated

vars - Whether variables debugging information should be generated

source - Whether source file debugging information should be generated

setCompilerOptions

public void setCompilerOptions(String[] compilerOptions)

Notice: Don't use the '-g' options - these are controlled through setDebuggingInfo(boolean, boolean, boolean).

Parameters:

compilerOptions - All command line options supported by the JDK JAVAC tool

findClass

protected Class<?> findClass(String className)
                      throws ClassNotFoundException

Implementation of ClassLoader.findClass(String).

Overrides:

findClass in class ClassLoader

Throws:

ClassNotFoundException

findClass2

private Class<?> findClass2(String className)
                     throws IOException

Throws:

IOException

findClassFile

private JavaFileObject findClassFile(String className)
                              throws IOException

Throws:

IOException

getSourceResourceName

private static String getSourceResourceName(String className)

Constructs the name of a resource that could contain the source code of the class with the given name.

Notice that member types are declared inside a different type, so the relevant source file is that of the outermost declaring class.

Parameters:

className - Fully qualified class name, e.g. "pkg1.pkg2.Outer$Inner"

Returns:

the name of the resource, e.g. "pkg1/pkg2/Outer.java"