Package org.jppf.utils.compilation

Class SourceCompiler

java.lang.Object

org.jppf.utils.compilation.SourceCompiler

All Implemented Interfaces:

Closeable, AutoCloseable

public class SourceCompiler
extends Object
implements Closeable

This class encapsulates a Java platform compiler and provides an API to compile java sources provided as string to either the file system or an in-memory location.

Author:

Laurent Cohen

Constructor Summary

Constructors

Constructor	Description
SourceCompiler()	Initialize a SourceCompiler.
SourceCompiler(ClassLoader parentCL)	Initialize a SourceCompiler with the specified parent class loader.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this source compiler and its associated file manager.
void	compileToFile(Map<String,CharSequence> sources, File classesDir)	Compile the specified sources to the file system.
Map<String,byte[]>	compileToMemory(Map<String,CharSequence> sources)	Compile the specified sources to memory.
ClassLoader	getClassloader()	Get the class loader used to load the classes generated by this SourceCompiler.
List<Diagnostic<JavaFileObject>>	getDiagnostics()	Get the errors and warnings that occured during the last compilation operation.
static boolean	isCompilerAvailable()	Determines whether a compiler is available for this platform.

Methods inherited from class java.lang.Object

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

Constructor Details

SourceCompiler

public SourceCompiler()
               throws UnsupportedOperationException

Initialize a SourceCompiler.

Throws:

UnsupportedOperationException - if no compiler is available for this platform.

SourceCompiler

public SourceCompiler(ClassLoader parentCL)
               throws UnsupportedOperationException

Initialize a SourceCompiler with the specified parent class loader.

Parameters:

parentCL - the parent class loader used to build a class loader specific for this source compiler.

Throws:

UnsupportedOperationException - if no compiler is available for this platform.

Method Details

compileToFile

public void compileToFile(Map<String,CharSequence> sources,
 File classesDir)
                   throws Exception

Compile the specified sources to the file system.

Parameters:

sources - a mapping of class names to their source code.

classesDir - the root directory where the classes are stored. For instance, if a class mypackage.MyClass is compiled, the resulting class file will be at classesDir/mypackage/MyClass.class.

Throws:

Exception - if any error occurs.

compileToMemory

public Map<String,byte[]> compileToMemory(Map<String,CharSequence> sources)
                                   throws Exception

Compile the specified sources to memory.

Parameters:

sources - a mapping of class names to their source code.

Returns:

a mapping of the class names to their generated bytecode.

Throws:

Exception - if any error occurs.

close

public void close()
           throws IOException

Close this source compiler and its associated file manager.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if any I/O error occurs.

getDiagnostics

public List<Diagnostic<JavaFileObject>> getDiagnostics()

Get the errors and warnings that occured during the last compilation operation.

Returns:

a list of Diagnostic objects.

getClassloader

public ClassLoader getClassloader()

Get the class loader used to load the classes generated by this SourceCompiler.

Returns:

a ClassLoader instance.

isCompilerAvailable

public static boolean isCompilerAvailable()

Determines whether a compiler is available for this platform.

Returns:

true if a compiler is available, false otherwise.