net.openhft.compiler

Class CachedCompiler

java.lang.Object

net.openhft.compiler.CachedCompiler

All Implemented Interfaces:

Closeable, AutoCloseable

public class CachedCompiler
extends Object
implements Closeable

Manages in-memory compilation with an optional cache. When directories are supplied to the constructors, source and class files are also written to disk to aid debugging. Call close() once finished and use updateFileManagerForClassLoader(ClassLoader, java.util.function.Consumer) to tune a specific loader.

Field Summary

Fields

Modifier and Type	Field and Description
Function<StandardJavaFileManager,MyJavaFileManager>	fileManagerOverride Optional testing hook to replace the file manager implementation.

Constructor Summary

Constructors

Constructor and Description
CachedCompiler(@Nullable File sourceDir, @Nullable File classDir) Create a compiler that optionally writes sources and classes to the given directories.
CachedCompiler(@Nullable File sourceDir, @Nullable File classDir, @NotNull List<String> options) Create a compiler with explicit compiler options.

Method Summary

Modifier and Type	Method and Description
void	close() Close any file managers created by this compiler.
Class<?>	loadFromJava(@NotNull ClassLoader classLoader, @NotNull String className, @NotNull String javaCode) Compile the source using the supplied class loader.
Class<?>	loadFromJava(@NotNull ClassLoader classLoader, @NotNull String className, @NotNull String javaCode, @Nullable PrintWriter writer) Compile and load using a specific class loader and writer.
Class<?>	loadFromJava(@NotNull String className, @NotNull String javaCode) Compile the supplied source and load the class using this instance's class loader.
void	updateFileManagerForClassLoader(ClassLoader classLoader, Consumer<MyJavaFileManager> updateFileManager) Update the file manager for a specific class loader.

Methods inherited from class java.lang.Object

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

Field Detail

fileManagerOverride

public Function<StandardJavaFileManager,MyJavaFileManager> fileManagerOverride

Optional testing hook to replace the file manager implementation.

Constructor Detail

CachedCompiler

public CachedCompiler(@Nullable
                      @Nullable File sourceDir,
                      @Nullable
                      @Nullable File classDir)

Create a compiler that optionally writes sources and classes to the given directories. When sourceDir or classDir is not null, the corresponding files are written for debugging purposes.

CachedCompiler

public CachedCompiler(@Nullable
                      @Nullable File sourceDir,
                      @Nullable
                      @Nullable File classDir,
                      @NotNull
                      @NotNull List<String> options)

Create a compiler with explicit compiler options. Directories behave as in CachedCompiler(File, File) and allow inspection of generated output.

Parameters:

sourceDir - where sources are dumped when not null

classDir - where class files are dumped when not null

options - additional flags passed to the Java compiler

Method Detail

close

public void close()

Close any file managers created by this compiler. Normally called when the instance is discarded.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

loadFromJava

public Class<?> loadFromJava(@NotNull
                             @NotNull String className,
                             @NotNull
                             @NotNull String javaCode)
                      throws ClassNotFoundException

Compile the supplied source and load the class using this instance's class loader. Successfully compiled classes are cached for reuse.

Parameters:

className - expected binary name of the class

javaCode - source code to compile

Returns:

the loaded class instance

Throws:

ClassNotFoundException - if the compiled class cannot be defined

loadFromJava

public Class<?> loadFromJava(@NotNull
                             @NotNull ClassLoader classLoader,
                             @NotNull
                             @NotNull String className,
                             @NotNull
                             @NotNull String javaCode)
                      throws ClassNotFoundException

Compile the source using the supplied class loader. Cached classes are stored per loader key.

Parameters:

classLoader - loader to define the class with

className - expected binary name

javaCode - source code to compile

Returns:

the loaded class instance

Throws:

ClassNotFoundException - if definition fails

loadFromJava

public Class<?> loadFromJava(@NotNull
                             @NotNull ClassLoader classLoader,
                             @NotNull
                             @NotNull String className,
                             @NotNull
                             @NotNull String javaCode,
                             @Nullable
                             @Nullable PrintWriter writer)
                      throws ClassNotFoundException

Compile and load using a specific class loader and writer. The compilation result is cached against the loader for future calls.

Parameters:

classLoader - loader to define the class with

className - expected binary name

javaCode - source code to compile

writer - destination for diagnostic messages, may be null

Returns:

the loaded class instance

Throws:

ClassNotFoundException - if definition fails

updateFileManagerForClassLoader

public void updateFileManagerForClassLoader(ClassLoader classLoader,
                                            Consumer<MyJavaFileManager> updateFileManager)

Update the file manager for a specific class loader. This is mainly a testing utility and is ignored when no manager exists for the loader.

Parameters:

classLoader - the class loader to update

updateFileManager - function applying the update