org.codehaus.commons.compiler

Interface ICookable

All Known Subinterfaces:

IClassBodyEvaluator, IExpressionEvaluator, IScriptEvaluator, ISimpleCompiler

All Known Implementing Classes:

ClassBodyEvaluator, ClassBodyEvaluator, Cookable, ExpressionEvaluator, ExpressionEvaluator, ScriptEvaluator, ScriptEvaluator, SimpleCompiler, SimpleCompiler

public interface ICookable

"Cooking" means scanning a sequence of characters and turning them into some JVM-executable artifact. For example, if you cook a ClassBodyEvaluator, then the tokens are interpreted as a class body and compiled into a Class which is accessible through IClassBodyEvaluator.getClazz().

The cook*() methods eventually invoke the abstract cook(String, Reader) method.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassLoader	BOOT_CLASS_LOADER The ClassLoader that loads this classes on the boot class path, i.e. the JARs in the JRE's "lib" and "lib/ext" directories, but not the JARs and class directories specified through the class path.
static String	SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR If the source code is not read from a file, debuggers have a hard time locating the source file for source-level debugging.
static String	SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE Setting this system property to 'true' enables source-level debugging.

Method Summary

Modifier and Type	Method and Description
void	cook(InputStream is) Reads, scans, parses and compiles Java tokens from the given InputStream, encoded in the "platform default encoding".
void	cook(InputStream is, String optionalEncoding) Reads, scans, parses and compiles Java tokens from the given InputStream with the given encoding.
void	cook(Reader r) Reads, scans, parses and compiles Java tokens from the given Reader.
void	cook(String s) Reads, scans, parses and compiles Java tokens from the given String.
void	cook(String optionalFileName, InputStream is) Reads, scans, parses and compiles Java tokens from the given InputStream, encoded in the "platform default encoding".
void	cook(String optionalFileName, InputStream is, String optionalEncoding) Reads, scans, parses and compiles Java tokens from the given InputStream with the given encoding.
void	cook(String optionalFileName, Reader r) Reads, scans, parses and compiles Java tokens from the given Reader.
void	cook(String optionalFileName, String s) Reads, scans, parses and compiles Java tokens from the given String.
void	cookFile(File file) Reads, scans, parses and compiles Java tokens from the given File, encoded in the "platform default encoding".
void	cookFile(File file, String optionalEncoding) Reads, scans, parses and compiles Java tokens from the given File with the given encoding.
void	cookFile(String fileName) Reads, scans, parses and compiles Java tokens from the named file, encoded in the "platform default encoding".
void	cookFile(String fileName, String optionalEncoding) Reads, scans, parses and compiles Java tokens from the named file with the given optionalEncoding.
void	setCompileErrorHandler(ErrorHandler optionalCompileErrorHandler) By default, CompileExceptions are thrown on compile errors, but an application my install its own ErrorHandler.
void	setDebuggingInformation(boolean debugSource, boolean debugLines, boolean debugVars) Determines what kind of debugging information is included in the generates classes.
void	setParentClassLoader(ClassLoader optionalParentClassLoader) The "parent class loader" is used to load referenced classes.
void	setWarningHandler(WarningHandler optionalWarningHandler) By default, warnings are discarded, but an application my install a custom WarningHandler.

Field Detail

BOOT_CLASS_LOADER

static final ClassLoader BOOT_CLASS_LOADER

The ClassLoader that loads this classes on the boot class path, i.e. the JARs in the JRE's "lib" and "lib/ext" directories, but not the JARs and class directories specified through the class path.

SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE

static final String SYSTEM_PROPERTY_SOURCE_DEBUGGING_ENABLE

Setting this system property to 'true' enables source-level debugging. Typically, this means that compilation is executed with "-g:all" instead of "-g:none".

See Also:

Constant Field Values

SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR

static final String SYSTEM_PROPERTY_SOURCE_DEBUGGING_DIR

If the source code is not read from a file, debuggers have a hard time locating the source file for source-level debugging. As a workaround, a copy of the source code is written to a temporary file, which must be included in the debugger's source path. If this system property is set, the temporary source file is created in that directory, otherwise in the default temporary-file directory.

See Also:

File.createTempFile(String, String, File), Constant Field Values

Method Detail

setParentClassLoader

void setParentClassLoader(@Nullable
                          ClassLoader optionalParentClassLoader)

The "parent class loader" is used to load referenced classes. Useful values are:

System.getSystemClassLoader()	The running JVM's class path
Thread.currentThread().getContextClassLoader() or null	The class loader effective for the invoking thread
BOOT_CLASS_LOADER	The running JVM's boot class path

The parent class loader defaults to the current thread's context class loader.

setDebuggingInformation

void setDebuggingInformation(boolean debugSource,
                             boolean debugLines,
                             boolean debugVars)

Determines what kind of debugging information is included in the generates classes. The default is typically "-g:none", and "-g:all" if the system property "org.codehaus.janino.source_debugging.enable" is set to "true".

cook

void cook(@Nullable
          String optionalFileName,
          Reader r)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given Reader.

Parameters:

optionalFileName - Used when reporting errors and warnings

Throws:

CompileException

IOException

cook

void cook(Reader r)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given Reader.

Throws:

CompileException

IOException

cook

void cook(InputStream is)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given InputStream, encoded in the "platform default encoding".

Throws:

CompileException

IOException

cook

void cook(@Nullable
          String optionalFileName,
          InputStream is)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given InputStream, encoded in the "platform default encoding".

Parameters:

optionalFileName - Used when reporting errors and warnings

Throws:

CompileException

IOException

cook

void cook(InputStream is,
          @Nullable
          String optionalEncoding)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given InputStream with the given encoding.

Throws:

CompileException

IOException

cook

void cook(@Nullable
          String optionalFileName,
          InputStream is,
          @Nullable
          String optionalEncoding)
   throws CompileException,
          IOException

Reads, scans, parses and compiles Java tokens from the given InputStream with the given encoding.

Parameters:

optionalFileName - Used when reporting errors and warnings

Throws:

CompileException

IOException

cook

void cook(String s)
   throws CompileException

Reads, scans, parses and compiles Java tokens from the given String.

Throws:

CompileException

cook

void cook(@Nullable
          String optionalFileName,
          String s)
   throws CompileException

Reads, scans, parses and compiles Java tokens from the given String.

Parameters:

optionalFileName - Used when reporting errors and warnings

Throws:

CompileException

cookFile

void cookFile(File file)
       throws CompileException,
              IOException

Reads, scans, parses and compiles Java tokens from the given File, encoded in the "platform default encoding".

Throws:

CompileException

IOException

cookFile

void cookFile(File file,
              @Nullable
              String optionalEncoding)
       throws CompileException,
              IOException

Reads, scans, parses and compiles Java tokens from the given File with the given encoding.

Throws:

CompileException

IOException

cookFile

void cookFile(String fileName)
       throws CompileException,
              IOException

Reads, scans, parses and compiles Java tokens from the named file, encoded in the "platform default encoding".

Throws:

CompileException

IOException

cookFile

void cookFile(String fileName,
              @Nullable
              String optionalEncoding)
       throws CompileException,
              IOException

Reads, scans, parses and compiles Java tokens from the named file with the given optionalEncoding.

Throws:

CompileException

IOException

setCompileErrorHandler

void setCompileErrorHandler(@Nullable
                            ErrorHandler optionalCompileErrorHandler)

By default, CompileExceptions are thrown on compile errors, but an application my install its own ErrorHandler.

Be aware that a single problem during compilation often causes a bunch of compile errors, so a good ErrorHandler counts errors and throws a CompileException when a limit is reached.

If the given ErrorHandler throws CompileExceptions, then the compilation is terminated and the exception is propagated.

If the given ErrorHandler does not throw CompileExceptions, then the compiler may or may not continue compilation, but must eventually throw a CompileException.

In other words: The ErrorHandler may throw a CompileException or not, but the compiler must definitely throw a CompileException if one or more compile errors have occurred.

Parameters:

optionalCompileErrorHandler - null to restore the default behavior (throwing a CompileException

setWarningHandler

void setWarningHandler(@Nullable
                       WarningHandler optionalWarningHandler)

By default, warnings are discarded, but an application my install a custom WarningHandler.

Parameters:

optionalWarningHandler - null to indicate that no warnings be issued