org.jenkinsci.groovy.binder

Class GroovyWiringModule

java.lang.Object

com.google.inject.AbstractModule

org.jenkinsci.groovy.binder.GroovyWiringModule

All Implemented Interfaces:

com.google.inject.Module

public class GroovyWiringModule
extends com.google.inject.AbstractModule

Loads Groovy binder DSL as Module.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
GroovyWiringModule(Collection<URL> scripts)
GroovyWiringModule(URL... scripts)

Method Summary

Methods

Modifier and Type	Method and Description
GroovyWiringModule	addImports(Class... classes)
GroovyWiringModule	addImports(String... imports)
GroovyWiringModule	addStarImports(String... packages)
static GroovyWiringModule	allOf(File scriptsFiles) Creates that loads all the specified script files.
protected void	configure()
protected groovy.lang.GroovyShell	createShell() Creates GroovyShell that controls how scripts are loaded.
GroovyWiringModule	withClassLoader(ClassLoader cl) Sets the class loader that determines what classes Groovy wiring script will see.
GroovyWiringModule	withLogLevel(Level l) Tweaks the logging level to report which scripts are loaded.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyWiringModule

public GroovyWiringModule(URL... scripts)

GroovyWiringModule

public GroovyWiringModule(Collection<URL> scripts)

Method Detail

withLogLevel

public GroovyWiringModule withLogLevel(Level l)

Tweaks the logging level to report which scripts are loaded. On the server-side use, it tends to be preferrable to set this to Level.INFO so that the log indicates precisely what's loaded.

withClassLoader

public GroovyWiringModule withClassLoader(ClassLoader cl)

Sets the class loader that determines what classes Groovy wiring script will see.

addImports

public GroovyWiringModule addImports(String... imports)

addStarImports

public GroovyWiringModule addStarImports(String... packages)

addImports

public GroovyWiringModule addImports(Class... classes)

configure

protected void configure()

Specified by:

configure in class com.google.inject.AbstractModule

allOf

public static GroovyWiringModule allOf(File scriptsFiles)
                                throws IOException

Creates that loads all the specified script files.

Parameters:

scriptsFiles - If this is a file, that single file is loaded. If this is a directory, all the "*.groovy" files in this directory gets loaded (in their lexicographical order to guarantee consistency.)

Throws:

IOException

createShell

protected groovy.lang.GroovyShell createShell()

Creates GroovyShell that controls how scripts are loaded.