ch.grengine

Class Grengine.Grape

java.lang.Object

ch.grengine.Grengine.Grape

Enclosing class:

Grengine

public static class Grengine.Grape
extends Object

Convenience class for easily getting a Grengine that works with Grape, eliminating also a Groovy issue related to Grape (GROOVY-7407).

Call activate() once before using the newGrengine() methods to create a Grengine instance that works with Grape.

See the user manual at "Grengine and Grape" and the DefaultGroovyCompiler class for more information.

Since:

1.2

Author:

Alain Stalder, Made in Switzerland.

Constructor Summary

Constructors

Constructor and Description
Grape()

Method Summary

Modifier and Type	Method and Description
static void	activate() activate Grape.
static void	activate(Object lock) activate Grape.
static void	deactivate() deactivate Grape.
static Grengine	newGrengine() equivalent to Grengine(), with the following differences.
static Grengine	newGrengine(Collection<URL> urls) equivalent to Grengine(Collection), with the following differences.
static Grengine	newGrengine(org.codehaus.groovy.control.CompilerConfiguration config) equivalent to Grengine(CompilerConfiguration), with the following differences.
static Grengine	newGrengine(org.codehaus.groovy.control.CompilerConfiguration config, Collection<URL> urls) equivalent to Grengine(CompilerConfiguration, Collection), with the following differences.
static Grengine	newGrengine(org.codehaus.groovy.control.CompilerConfiguration config, File dir) equivalent to Grengine(CompilerConfiguration, File), with the following differences.
static Grengine	newGrengine(org.codehaus.groovy.control.CompilerConfiguration config, File dir, DirMode dirMode) equivalent to Grengine(CompilerConfiguration, File, DirMode), with the following differences.
static Grengine	newGrengine(File dir) equivalent to Grengine(File), with the following differences.
static Grengine	newGrengine(File dir, DirMode dirMode) equivalent to Grengine(File, DirMode), with the following differences.
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent) equivalent to Grengine(ClassLoader), with the following differences.
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, Collection<URL> urls) equivalent to Grengine(ClassLoader, Collection), with the following differences.
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, org.codehaus.groovy.control.CompilerConfiguration config) equivalent to Grengine(ClassLoader, CompilerConfiguration).
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, org.codehaus.groovy.control.CompilerConfiguration config, Collection<URL> urls) equivalent to Grengine(ClassLoader, CompilerConfiguration, Collection).
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, org.codehaus.groovy.control.CompilerConfiguration config, File dir) equivalent to Grengine(ClassLoader, CompilerConfiguration, File).
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, org.codehaus.groovy.control.CompilerConfiguration config, File dir, DirMode dirMode) equivalent to Grengine(ClassLoader, CompilerConfiguration, File, DirMode).
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, File dir) equivalent to Grengine(ClassLoader, File), with the following differences.
static Grengine	newGrengine(groovy.lang.GroovyClassLoader parent, File dir, DirMode dirMode) equivalent to Grengine(ClassLoader, File, DirMode), with the following differences.

Methods inherited from class java.lang.Object

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

Constructor Detail

Grape

public Grape()

Method Detail

activate

public static void activate()

activate Grape.

See DefaultGroovyCompiler.enableGrapeSupport() and the user manual for more information.

Since:

1.2

activate

public static void activate(Object lock)

activate Grape.

See DefaultGroovyCompiler.enableGrapeSupport(Object) and the user manual for more information.

Parameters:

lock - lock to use

Since:

1.2

deactivate

public static void deactivate()

deactivate Grape.

See DefaultGroovyCompiler.disableGrapeSupport() and the user manual for more information.

Since:

1.2

newGrengine

public static Grengine newGrengine()

equivalent to Grengine(), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent. Compiler configuration is the default compiler configuration, with added Grape support.

Returns:

new instance

Since:

1.2

newGrengine

public static Grengine newGrengine(org.codehaus.groovy.control.CompilerConfiguration config)

equivalent to Grengine(CompilerConfiguration), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent.

Parameters:

config - compiler configuration to use for compiling all sources, Grape support is added to it

Returns:

new instance

Throws:

NullPointerException - if the compiler configuration is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent)

equivalent to Grengine(ClassLoader), with the following differences.

Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

parent - parent class loader for the engine

Returns:

new instance

Throws:

NullPointerException - if the parent class loader is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   org.codehaus.groovy.control.CompilerConfiguration config)

equivalent to Grengine(ClassLoader, CompilerConfiguration).

Parameters:

parent - parent class loader for the engine

config - compiler configuration to use for compiling all sources, Grape support is added to it

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(File dir)

equivalent to Grengine(File), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent. Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

dir - script directory

Returns:

new instance

Throws:

NullPointerException - if the directory is null

Since:

1.2

newGrengine

public static Grengine newGrengine(org.codehaus.groovy.control.CompilerConfiguration config,
                                   File dir)

equivalent to Grengine(CompilerConfiguration, File), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent.

Parameters:

config - compiler configuration to use for compiling all sources, Grape support is added to it

dir - script directory

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   File dir)

equivalent to Grengine(ClassLoader, File), with the following differences.

Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

parent - parent class loader for the engine

dir - script directory

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   org.codehaus.groovy.control.CompilerConfiguration config,
                                   File dir)

equivalent to Grengine(ClassLoader, CompilerConfiguration, File).

Parameters:

parent - parent class loader for the engine

config - compiler configuration to use for compiling all sources, Grape support is added to it

dir - script directory

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(File dir,
                                   DirMode dirMode)

equivalent to Grengine(File, DirMode), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent. Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

dir - script directory

dirMode - dir mode

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(org.codehaus.groovy.control.CompilerConfiguration config,
                                   File dir,
                                   DirMode dirMode)

equivalent to Grengine(CompilerConfiguration, File, DirMode), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent.

Parameters:

config - compiler configuration to use for compiling all sources, Grape support is added to it

dir - script directory

dirMode - dir mode

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   File dir,
                                   DirMode dirMode)

equivalent to Grengine(ClassLoader, File, DirMode), with the following differences.

Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

parent - parent class loader for the engine

dir - script directory

dirMode - dir mode

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   org.codehaus.groovy.control.CompilerConfiguration config,
                                   File dir,
                                   DirMode dirMode)

equivalent to Grengine(ClassLoader, CompilerConfiguration, File, DirMode).

Parameters:

parent - parent class loader for the engine

config - compiler configuration to use for compiling all sources, Grape support is added to it

dir - script directory

dirMode - dir mode

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(Collection<URL> urls)

equivalent to Grengine(Collection), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent. Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

urls - collection of URL-based scripts

Returns:

new instance

Throws:

NullPointerException - if the URL collection is null

Since:

1.2

newGrengine

public static Grengine newGrengine(org.codehaus.groovy.control.CompilerConfiguration config,
                                   Collection<URL> urls)

equivalent to Grengine(CompilerConfiguration, Collection), with the following differences.

Parent class loader is a GroovyClassLoader with the context class loader of the current thread as its parent.

Parameters:

config - compiler configuration to use for compiling all sources, Grape support is added to it

urls - collection of URL-based scripts

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   Collection<URL> urls)

equivalent to Grengine(ClassLoader, Collection), with the following differences.

Compiler configuration is the default compiler configuration, with added Grape support.

Parameters:

parent - parent class loader for the engine

urls - collection of URL-based scripts

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2

newGrengine

public static Grengine newGrengine(groovy.lang.GroovyClassLoader parent,
                                   org.codehaus.groovy.control.CompilerConfiguration config,
                                   Collection<URL> urls)

equivalent to Grengine(ClassLoader, CompilerConfiguration, Collection).

Parameters:

parent - parent class loader for the engine

config - compiler configuration to use for compiling all sources, Grape support is added to it

urls - collection of URL-based scripts

Returns:

new instance

Throws:

NullPointerException - if any argument is null

Since:

1.2