api / org.gradle.api.tasks / GroovyRuntime

GroovyRuntime

@Incubating open class GroovyRuntime

Provides information related to the Groovy runtime(s) used in a project. Added by the org.gradle.api.plugins.GroovyBasePlugin as a project extension named groovyRuntime.

Example usage: 

 apply plugin: "groovy" repositories { mavenCentral() } dependencies { compile "org.codehaus.groovy:groovy-all:2.1.2" } def groovyClasspath = groovyRuntime.inferGroovyClasspath(configurations.compile) // The returned class path can be used to configure the 'groovyClasspath' property of tasks // such as 'GroovyCompile' or 'Groovydoc', or to execute these and other Groovy tools directly.

Constructors

<init>

 GroovyRuntime(project: Project)

Functions

inferGroovyClasspath

 open fun inferGroovyClasspath(classpath: MutableIterable<File>): FileCollection

Searches the specified class path for Groovy Jars (groovy(-indy), groovy-all(-indy)) and returns a corresponding class path for executing Groovy tools such as the Groovy compiler and Groovydoc tool. The tool versions will match those of the Groovy Jars found. If no Groovy Jars are found on the specified class path, a class path with the contents of the groovy configuration will be returned.

The returned class path may be empty, or may fail to resolve when asked for its contents.

Extension Properties

ext

 val GroovyRuntime.ext: ExtraPropertiesExtension

Retrieves the ext extension.

Extension Functions

ext

 fun GroovyRuntime.ext(configure: ExtraPropertiesExtension.() -> Unit): Unit

Configures the ext extension.