Modifier and Type	Class and Description
private class	Compiler.CompilerIClassLoader A specialized `IClassLoader` that loads `IClass`es from the following sources: An already-parsed compilation unit A class file in the output directory (if existent and younger than source file) A source file in any of the source path directories The parent class loader

Modifier and Type	Field and Description
private Benchmark	benchmark
public static final StringPattern[]	DEFAULT_WARNING_HANDLE_PATTERNS The default value for the `warningHandlerPatterns` parameter of `Compiler#Compiler(File[], File[], File[], File[], File, String, boolean, boolean, boolean, boolean, StringPattern[], boolean)`.
private IClassLoader	iClassLoader
private static final Logger	LOGGER
private EnumSet<JaninoOption>	options
private final List<UnitCompiler>	parsedCompilationUnits

Access	Constructor and Description
public	Compiler() Initializes a new compiler.
public	Compiler(ResourceFinder sourceFinder, IClassLoader parentIClassLoader) Deprecated Use `Compiler()` and the various configuration setters instead
public	Compiler(final File[] sourcePath, final File[] classPath, final File[] extDirs, final File[] bootClassPath, final File destinationDirectory, final String characterEncoding, boolean verbose, boolean debugSource, boolean debugLines, boolean debugVars, StringPattern[] warningHandlePatterns, boolean rebuild) Deprecated Use `Compiler()` and the various configuration setters instead

Method Summary

Modifier and Type	Method and Description
public void	compile(Resource[] Contain the compilation units to compile sourceResources) Implements org.codehaus.commons.compiler.ICompiler.compile. See `compile(File[])`.
private void	compile2(Resource[] sourceResources)
public static File	getClassFile(String E.g. `"pkg1.pkg2.Outer$Inner"` className, File E.g. `"srcdir/Outer.java"` sourceFile, File E.g. `"destdir"` destinationDirectory) Constructs the name of a file that could store the byte code of the class with the given name.
private IClassLoader	Returns: Loads "auxiliary classes", either through the `IClassLoader` that was explicitly set with `setIClassLoader(IClassLoader)`, or otherwise from `setBootClassPath(File[])`, `setExtensionDirectories(File[])` and `setClassPath(File[])` getIClassLoader()
private static <T> T[]	nullToEmptyArray(T[] a, Class<T> elementType)
public EnumSet<JaninoOption>	Returns: A reference to the currently effective compilation options; changes to it take effect immediately options()
public Compiler	options(EnumSet<JaninoOption> options) Sets the options for all future compilations.
private Java.AbstractCompilationUnit	Returns: the parsed compilation unit parseAbstractCompilationUnit(String fileName, InputStream inputStream, Charset charset) Reads one compilation unit from a file and parses it.
public void	setIClassLoader(IClassLoader iClassLoader) Explicitly sets the `IClassLoader` that will be used to load "auxiliary classes".
public void	setVerbose(boolean verbose) Implements org.codehaus.commons.compiler.ICompiler.setVerbose. Equivalent of `-verbose`.
public void	storeClassFile(ClassFile classFile, final File Required to compute class file path if no destination directory given sourceFile) Stores the byte code of this `ClassFile` in the file system.

Field Detail

benchmark	back to summary
private Benchmark benchmark

DEFAULT_WARNING_HANDLE_PATTERNS	back to summary
public static final StringPattern[] DEFAULT_WARNING_HANDLE_PATTERNS The default value for the `warningHandlerPatterns` parameter of `Compiler#Compiler(File[], File[], File[], File[], File, String, boolean, boolean, boolean, boolean, StringPattern[], boolean)`.

iClassLoader	back to summary
private IClassLoader iClassLoader Annotations @Nullable

LOGGER	back to summary
private static final Logger LOGGER

options	back to summary
private EnumSet<JaninoOption> options

parsedCompilationUnits	back to summary
private final List<UnitCompiler> parsedCompilationUnits

Compiler	back to summary
public Compiler() Initializes a new compiler.

Compiler	back to summary
public Compiler(ResourceFinder sourceFinder, IClassLoader parentIClassLoader) Deprecated Use `Compiler()` and the various configuration setters instead Annotations @Deprecated

Compiler	back to summary
public Compiler(final File[] sourcePath, final File[] classPath, final File[] extDirs, final File[] bootClassPath, final File destinationDirectory, final String characterEncoding, boolean verbose, boolean debugSource, boolean debugLines, boolean debugVars, StringPattern[] warningHandlePatterns, boolean rebuild) Deprecated Use `Compiler()` and the various configuration setters instead Annotations @Deprecated

Method Detail

compile back to summary

compile	back to summary
public void compile(Resource[] sourceResources) throws CompileException, IOException Implements org.codehaus.commons.compiler.ICompiler.compile. Doc from org.codehaus.commons.compiler.ICompiler.compile. See `compile(File[])`. Parameters sourceResources:Resource[] Contain the compilation units to compile Annotations @Override

public void compile(Resource[] sourceResources) throws CompileException, IOException

Implements org.codehaus.commons.compiler.ICompiler.compile.

Doc from org.codehaus.commons.compiler.ICompiler.compile.

See compile(File[]).

Parameters

sourceResources:Resource[]: Contain the compilation units to compile

Annotations

@Override

compile2	back to summary
private void compile2(Resource[] sourceResources) throws CompileException, IOException

getClassFile back to summary

getClassFile	back to summary
public static File getClassFile(String className, File sourceFile, File destinationDirectory) Constructs the name of a file that could store the byte code of the class with the given name. If `destinationDirectory` is non-`null`, the returned path is the `destinationDirectory` plus the package of the class (with dots replaced with file separators) plus the class name plus ".class". Example: "destdir/pkg1/pkg2/Outer$Inner.class" If `destinationDirectory` is null, the returned path is the directory of the `sourceFile` plus the class name plus ".class". Example: "srcdir/Outer$Inner.class" Parameters className:String E.g. `"pkg1.pkg2.Outer$Inner"` sourceFile:File E.g. `"srcdir/Outer.java"` destinationDirectory:File E.g. `"destdir"`

public static File getClassFile(String className, File sourceFile, File destinationDirectory)

Constructs the name of a file that could store the byte code of the class with the given name.

If destinationDirectory is non-null, the returned path is the destinationDirectory plus the package of the class (with dots replaced with file separators) plus the class name plus ".class". Example: "destdir/pkg1/pkg2/Outer$Inner.class"

If destinationDirectory is null, the returned path is the directory of the sourceFile plus the class name plus ".class". Example: "srcdir/Outer$Inner.class"

Parameters

className:String: E.g. "pkg1.pkg2.Outer$Inner"
sourceFile:File: E.g. "srcdir/Outer.java"
destinationDirectory:File: E.g. "destdir"

getIClassLoader	back to summary
private IClassLoader getIClassLoader() Returns:IClassLoader Loads "auxiliary classes", either through the `IClassLoader` that was explicitly set with `setIClassLoader(IClassLoader)`, or otherwise from `setBootClassPath(File[])`, `setExtensionDirectories(File[])` and `setClassPath(File[])`

nullToEmptyArray	back to summary
private static <T> T[] nullToEmptyArray(T[] a, Class<T> elementType) Annotations @SuppressWarnings:unchecked

options	back to summary
public EnumSet<JaninoOption> options() Returns:EnumSet<JaninoOption> A reference to the currently effective compilation options; changes to it take effect immediately

options	back to summary
public Compiler options(EnumSet<JaninoOption> options) Sets the options for all future compilations.

parseAbstractCompilationUnit	back to summary
private Java.AbstractCompilationUnit parseAbstractCompilationUnit(String fileName, InputStream inputStream, Charset charset) throws CompileException, IOException Reads one compilation unit from a file and parses it. The `inputStream` is closed before the method returns. Returns:Java.AbstractCompilationUnit the parsed compilation unit

parseAbstractCompilationUnit

back to summary

private Java.AbstractCompilationUnit parseAbstractCompilationUnit(String fileName, InputStream inputStream, Charset charset) throws CompileException, IOException

Reads one compilation unit from a file and parses it.

The inputStream is closed before the method returns.

Returns:Java.AbstractCompilationUnit: the parsed compilation unit

setIClassLoader	back to summary
public void setIClassLoader(IClassLoader iClassLoader) Explicitly sets the `IClassLoader` that will be used to load "auxiliary classes". If this method is used, then `setBootClassPath(File[])`, `setExtensionDirectories(File[])` and `setClassPath(File[])` have no more effect.

setVerbose back to summary

setVerbose	back to summary
public void setVerbose(boolean verbose) Implements org.codehaus.commons.compiler.ICompiler.setVerbose. Doc from org.codehaus.commons.compiler.ICompiler.setVerbose. Equivalent of `-verbose`. Annotations @Override

public void setVerbose(boolean verbose)

Implements org.codehaus.commons.compiler.ICompiler.setVerbose.

Doc from org.codehaus.commons.compiler.ICompiler.setVerbose.

Equivalent of -verbose.

Annotations

@Override

storeClassFile back to summary

storeClassFile	back to summary
public void storeClassFile(ClassFile classFile, final File sourceFile) throws IOException Stores the byte code of this `ClassFile` in the file system. Directories are created as necessary. Parameters sourceFile:File Required to compute class file path if no destination directory given

public void storeClassFile(ClassFile classFile, final File sourceFile) throws IOException

Stores the byte code of this ClassFile in the file system. Directories are created as necessary.

Parameters

sourceFile:File: Required to compute class file path if no destination directory given

org.codehaus.janino back to summary

private Class Compiler.CompilerIClassLoader

Class Inheritance

extends IClassLoader

java.lang.Object
org.codehaus.janino.IClassLoader
org.codehaus.janino.Compiler.CompilerIClassLoader

A specialized IClassLoader that loads IClasses from the following sources:

An already-parsed compilation unit
A class file in the output directory (if existent and younger than source file)
A source file in any of the source path directories
The parent class loader

Notice that the CompilerIClassLoader is an inner class of Compiler and heavily uses Compiler's members.

Field Summary

Modifier and Type	Field and Description
private final ResourceFinder	classFileFinder
private final ResourceFinder	sourceFinder

Inherited from org.codehaus.janino.IClassLoader:: CTOR_java_lang_StringBuilder__java_lang_String METH_java_lang_Enum__ordinal METH_java_lang_Iterable__iterator METH_java_lang_String__concat__java_lang_String METH_java_lang_String__equals__java_lang_Object METH_java_lang_String__hashCode METH_java_lang_String__valueOf__boolean METH_java_lang_String__valueOf__char METH_java_lang_String__valueOf__double METH_java_lang_String__valueOf__float METH_java_lang_String__valueOf__int METH_java_lang_String__valueOf__java_lang_Object METH_java_lang_String__valueOf__long METH_java_lang_StringBuilder__append__boolean METH_java_lang_StringBuilder__append__char METH_java_lang_StringBuilder__append__double METH_java_lang_StringBuilder__append__float METH_java_lang_StringBuilder__append__int METH_java_lang_StringBuilder__append__java_lang_Object METH_java_lang_StringBuilder__append__java_lang_String METH_java_lang_StringBuilder__append__long METH_java_lang_StringBuilder__toString METH_java_lang_Throwable__addSuppressed METH_java_util_Iterator__hasNext METH_java_util_Iterator__next TYPE_java_io_Serializable TYPE_java_lang_annotation_Retention TYPE_java_lang_AssertionError TYPE_java_lang_Boolean TYPE_java_lang_Byte TYPE_java_lang_Character TYPE_java_lang_Class TYPE_java_lang_Cloneable TYPE_java_lang_Double TYPE_java_lang_Enum TYPE_java_lang_Error TYPE_java_lang_Exception TYPE_java_lang_Float TYPE_java_lang_Integer TYPE_java_lang_Iterable TYPE_java_lang_Long TYPE_java_lang_Object TYPE_java_lang_Override TYPE_java_lang_RuntimeException TYPE_java_lang_Short TYPE_java_lang_String TYPE_java_lang_StringBuilder TYPE_java_lang_System TYPE_java_lang_Throwable TYPE_java_lang_Void TYPE_java_util_Iterator

Constructor Summary

Access	Constructor and Description
pack-priv	CompilerIClassLoader(ResourceFinder Where to look for more source files sourceFinder, ResourceFinder Where to look for previously generated .class resources, or `FIND_NEXT_TO_SOURCE_FILE` classFileFinder, IClassLoader `IClassLoader` through which `IClass`es are to be loaded parentIClassLoader)

Method Summary

Modifier and Type	Method and Description
private IClass	defineIClassFromClassFileResource(Resource classFileResource) Opens the given `classFileResource`, reads its contents, defines it in the `IClassLoader`, and resolves it (this step may involve loading more classes).
private IClass	defineIClassFromSourceResource(Resource sourceResource, String className) Parses the compilation unit stored in the given `sourceResource`, remembers it in `Compiler.this.parsedCompilationUnits` (it may declare other classes that are needed later), finds the declaration of the type with the given `className`, and defines it in the `IClassLoader`.
protected IClass	Returns: `null` if a the type could not be found findIClass(final String field descriptor of the `IClass` to load, e.g. `"Lpkg1/pkg2/Outer$Inner;"` type) Implements abstract org.codehaus.janino.IClassLoader.findIClass. Finds a new `IClass` by descriptor and calls `defineIClass(IClass)`.

Inherited from org.codehaus.janino.IClassLoader:: createJavacLikePathIClassLoader defineIClass getArrayIClass getArrayIClass getParentIClassLoader loadIClass postConstruct

Field Detail

classFileFinder	back to summary
private final ResourceFinder classFileFinder Annotations @Nullable

sourceFinder	back to summary
private final ResourceFinder sourceFinder

Constructor Detail

CompilerIClassLoader back to summary

CompilerIClassLoader	back to summary
pack-priv CompilerIClassLoader(ResourceFinder sourceFinder, ResourceFinder classFileFinder, IClassLoader parentIClassLoader) Parameters sourceFinder:ResourceFinder Where to look for more source files classFileFinder:ResourceFinder Where to look for previously generated .class resources, or `FIND_NEXT_TO_SOURCE_FILE` parentIClassLoader:IClassLoader `IClassLoader` through which `IClass`es are to be loaded

pack-priv CompilerIClassLoader(ResourceFinder sourceFinder, ResourceFinder classFileFinder, IClassLoader parentIClassLoader)

Parameters

sourceFinder:ResourceFinder: Where to look for more source files
classFileFinder:ResourceFinder: Where to look for previously generated .class resources, or FIND_NEXT_TO_SOURCE_FILE
parentIClassLoader:IClassLoader: IClassLoader through which IClasses are to be loaded

Method Detail

defineIClassFromClassFileResource	back to summary
private IClass defineIClassFromClassFileResource(Resource classFileResource) throws ClassNotFoundException Opens the given `classFileResource`, reads its contents, defines it in the `IClassLoader`, and resolves it (this step may involve loading more classes).

defineIClassFromSourceResource back to summary

defineIClassFromSourceResource	back to summary
private IClass defineIClassFromSourceResource(Resource sourceResource, String className) throws ClassNotFoundException Parses the compilation unit stored in the given `sourceResource`, remembers it in `Compiler.this.parsedCompilationUnits` (it may declare other classes that are needed later), finds the declaration of the type with the given `className`, and defines it in the `IClassLoader`. Notice that the compilation unit is not compiled here!

private IClass defineIClassFromSourceResource(Resource sourceResource, String className) throws ClassNotFoundException

Parses the compilation unit stored in the given sourceResource, remembers it in Compiler.this.parsedCompilationUnits (it may declare other classes that are needed later), finds the declaration of the type with the given className, and defines it in the IClassLoader.

Notice that the compilation unit is not compiled here!

findIClass back to summary

findIClass	back to summary
protected IClass findIClass(final String type) throws ClassNotFoundException Implements abstract org.codehaus.janino.IClassLoader.findIClass. Doc from org.codehaus.janino.IClassLoader.findIClass. Finds a new `IClass` by descriptor and calls `defineIClass(IClass)`. Similar `java.lang.ClassLoader#findClass(java.lang.String)`, this method must Get an `IClass` object from somewhere for the given type Call `defineIClass(IClass)` with that `IClass` object as the argument Return the `IClass` object The format of a `descriptor` is defined in JVMS 4.3.2. Typical descriptors are: `I` (Integer) `Lpkg1/pkg2/Clazz;` (Class declared in package) `Lpkg1/pkg2/Outer$Inner;` Member class Notice that this method is never called for array types. Notice that this method is never called from more than one thread at a time. In other words, implementations of this method need not be thread-safe. Parameters type:String field descriptor of the `IClass` to load, e.g. `"Lpkg1/pkg2/Outer$Inner;"` Returns:IClass `null` if a the type could not be found Annotations @Override @Nullable Exceptions ClassNotFoundException: An exception was raised while loading the `IClass`

protected IClass findIClass(final String type) throws ClassNotFoundException

Implements abstract org.codehaus.janino.IClassLoader.findIClass.

Doc from org.codehaus.janino.IClassLoader.findIClass.

Finds a new IClass by descriptor and calls defineIClass(IClass).

Similar java.lang.ClassLoader#findClass(java.lang.String), this method must

Get an IClass object from somewhere for the given type
Call defineIClass(IClass) with that IClass object as the argument
Return the IClass object

The format of a descriptor is defined in JVMS 4.3.2. Typical descriptors are:

I (Integer)
Lpkg1/pkg2/Clazz; (Class declared in package)
Lpkg1/pkg2/Outer$Inner; Member class

Notice that this method is never called for array types.

Notice that this method is never called from more than one thread at a time. In other words, implementations of this method need not be thread-safe.

Parameters

type:String: field descriptor of the IClass to load, e.g. "Lpkg1/pkg2/Outer$Inner;"

Returns:IClass

null if a the type could not be found

Annotations

@Override
@Nullable

Exceptions

ClassNotFoundException:: An exception was raised while loading the IClass

public Class Compiler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Compiler.CompilerIClassLoader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail