ch.grengine.code.groovy

Class DefaultGroovyCompiler

java.lang.Object

ch.grengine.code.groovy.DefaultGroovyCompiler

All Implemented Interfaces:

Compiler

public class DefaultGroovyCompiler
extends Object
implements Compiler

Default Groovy compiler.

Since:

1.0

Author:

Alain Stalder, Made in Switzerland.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultGroovyCompiler.Builder Builder for instances of DefaultGroovyCompiler.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultGroovyCompiler() constructor from parent class loader set to the context class loader of the current thread and from default compiler configuration.
	DefaultGroovyCompiler(ClassLoader parent) constructor from given parent class loader and default compiler configuration.
	DefaultGroovyCompiler(ClassLoader parent, org.codehaus.groovy.control.CompilerConfiguration config) constructor from given parent class loader and compiler configuration.
protected	DefaultGroovyCompiler(DefaultGroovyCompiler.Builder builder) constructor from builder.

Method Summary

Modifier and Type	Method and Description
protected org.codehaus.groovy.control.SourceUnit	addToCompilationUnit(org.codehaus.groovy.control.CompilationUnit cu, Source source, Sources sources) adds the given source to the given compilation unit and returns the resulting source unit.
Code	compile(Sources sources) compiles the given Groovy script sources to an instance of Code in memory.
static void	disableGrapeSupport() disable Grape support.
static void	enableGrapeSupport() enable Grape support with the Grape class as lock.
static void	enableGrapeSupport(Object lock) enable Grape support with the given class as lock.
DefaultGroovyCompiler.Builder	getBuilder() gets the builder.
org.codehaus.groovy.control.CompilerConfiguration	getCompilerConfiguration() gets the compiler configuration.
ClassLoader	getParent() gets the parent class loader.
static org.codehaus.groovy.control.CompilerConfiguration	withGrape(org.codehaus.groovy.control.CompilerConfiguration config, groovy.lang.GroovyClassLoader runtimeLoader) modifies the given compiler configuration for Grape support in this compiler.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGroovyCompiler

protected DefaultGroovyCompiler(DefaultGroovyCompiler.Builder builder)

constructor from builder.

Parameters:

builder - builder

Since:

1.0

DefaultGroovyCompiler

public DefaultGroovyCompiler()

constructor from parent class loader set to the context class loader of the current thread and from default compiler configuration.

Since:

1.0

DefaultGroovyCompiler

public DefaultGroovyCompiler(ClassLoader parent)

constructor from given parent class loader and default compiler configuration.

Parameters:

parent - parent class loader

Throws:

NullPointerException - if the parent class loader is null

Since:

1.0

DefaultGroovyCompiler

public DefaultGroovyCompiler(ClassLoader parent,
                             org.codehaus.groovy.control.CompilerConfiguration config)

constructor from given parent class loader and compiler configuration.

Parameters:

parent - parent class loader

config - compiler configuration

Throws:

NullPointerException - if the parent class loader or the compiler configuration is null

Since:

1.0

Method Detail

withGrape

public static org.codehaus.groovy.control.CompilerConfiguration withGrape(org.codehaus.groovy.control.CompilerConfiguration config,
                                                                          groovy.lang.GroovyClassLoader runtimeLoader)

modifies the given compiler configuration for Grape support in this compiler.

Only has an effect during compilation if Grape support had been enabled and only with this compiler class.

Parameters:

config - compiler configuration to enable for Grape

runtimeLoader - the GroovyClassLoader that is intended to be used later as a parent loader when loading classes compiled with the given compiler configuration

Returns:

modified compiler configuration, same instance as argument

Throws:

NullPointerException - if the compiler configuration is null

Since:

1.2

enableGrapeSupport

public static void enableGrapeSupport()

enable Grape support with the Grape class as lock.

Currently wraps the GrapeEngine in the Grape class with a wrapper that fixes an open Groovy issue (GROOVY-7407) using the lock and provides a mechanism needed for Grape with Grengine. See user manual under "Grengine and Grape" for more information.

Call once before using this compiler class in combination with Grengine (equivalent to calling Grengine.Grape.activate()).

Since:

1.2

enableGrapeSupport

public static void enableGrapeSupport(Object lock)

enable Grape support with the given class as lock.

Currently wraps the GrapeEngine in the Grape class with a wrapper that fixes an open Groovy issue (GROOVY-7407) using the lock and provides a mechanism needed for Grape with Grengine. See user manual under "Grengine and Grape" for more information.

Call once before using this compiler class in combination with Grengine (equivalent to calling Grengine.Grape.activate(lock)).

Parameters:

lock - the lock to use

Throws:

NullPointerException - if the lock is null

Since:

1.2

disableGrapeSupport

public static void disableGrapeSupport()

disable Grape support.

Currently unwraps the GrapeEngine in the Grape. See user manual under "Grengine and Grape" for more information.

Call once when done using this compiler class in combination with Grengine (equivalent to calling Grengine.Grape.deactivate()).

Since:

1.2

compile

public Code compile(Sources sources)

compiles the given Groovy script sources to an instance of Code in memory.

If CompilerConfiguration.getTargetDirectory() is not null, class files are also written to the target directory.

Specified by:

compile in interface Compiler

Parameters:

sources - sources

Returns:

code

Throws:

CompileException - if compilation failed

NullPointerException - if sources are null

Since:

1.0

addToCompilationUnit

protected org.codehaus.groovy.control.SourceUnit addToCompilationUnit(org.codehaus.groovy.control.CompilationUnit cu,
                                                                      Source source,
                                                                      Sources sources)

adds the given source to the given compilation unit and returns the resulting source unit.

Parameters:

cu - compilation unit

source - source

sources - all sources, needed only if the type of source is unsupported, for the resulting CompileException

Returns:

source unit

Throws:

CompileException - if the type of source is unsupported

Since:

1.0

getBuilder

public DefaultGroovyCompiler.Builder getBuilder()

gets the builder.

Returns:

builder

Since:

1.0

getParent

public ClassLoader getParent()

gets the parent class loader.

Returns:

parent class loader

Since:

1.0

getCompilerConfiguration

public org.codehaus.groovy.control.CompilerConfiguration getCompilerConfiguration()

gets the compiler configuration.

Returns:

compiler configuration

Since:

1.0