AbstractJRubyExecTask (jrubygradle-resolver 2.3.2 API)

org.ysb33r.gradle.jruby.api.tasks.AbstractJRubyExecTask

All Implemented Interfaces and Traits:: JRubyExecOptions

@groovy.transform.CompileStatic
class AbstractJRubyExecTask
extends org.ysb33r.grolifant5.api.core.runnable.AbstractJvmScriptExecTask<JRubyExecSpec>
implements JRubyExecOptions

Base class for setting up JRuby executions.

Authors:: Schalk W. Cronjé

Properties Summary

Properties
Type	Name and description
`JRubyEnvironmentInheritance`	`inheritRubyEnv`

Constructor Summary

Constructors
Constructor and description
`protected AbstractJRubyExecTask (WorkerExecutor we)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exec()`
	`JRubyEnvironmentInheritance`	`getInheritRubyEnv()` Allows for use script author to control the effect of the system Ruby environment.
	`void`	`setGemDirProvider(TaskProvider<? extends AbstractGemPrepareTask> task)` Set directory where GEMs are installed.
	`void`	`setGemDirProvider(Provider<File> gdp)` Set directory where GEMs are installed.
	`void`	`setInheritRubyEnv(JRubyEnvironmentInheritance mode)` Allows for use script author to control the effect of the system Ruby environment.
	`protected void`	`setJrubyJarProvider(Object provider)` Location of `jruby-complete` JAR.
	`void`	`withModuleOpens()` Shortcut to open modules when needed for execution.
	`void`	`withSystemPath()` Shortcut to ensure system path is added to JRuby environment.

- Property Detail
  - JRubyEnvironmentInheritance inheritRubyEnv
- Constructor Detail
  - protected AbstractJRubyExecTask(WorkerExecutor we)
- Method Detail
  - @Override void exec()
  - @Input JRubyEnvironmentInheritance getInheritRubyEnv()
    
    Allows for use script author to control the effect of the system Ruby environment.
    Returns:
    How much of the JRuby system environment should be inherited.
  - void setGemDirProvider(TaskProvider<? extends AbstractGemPrepareTask> task)
    
    Set directory where GEMs are installed.
    Parameters:
    gdp - Provider to a task which will install GEMs.
  - void setGemDirProvider(Provider<File> gdp)
    
    Set directory where GEMs are installed.
    Parameters:
    gdp - Provider to a directory
  - void setInheritRubyEnv(JRubyEnvironmentInheritance mode)
    
    Allows for use script author to control the effect of the system Ruby environment.
    Parameters:
    mode - How much of JRuby system environment should be inherited.
  - protected void setJrubyJarProvider(Object provider)
    
    Location of jruby-complete JAR. The derived implementation needs to call this to set up the correct location.
    Parameters:
    provider - An object that will provide the location of jruby-complete. Must resolve to a File instance.
  - @Override void withModuleOpens()
    
    Shortcut to open modules when needed for execution.
    Since:
    2.3
  - @Override void withSystemPath()
    
    Shortcut to ensure system path is added to JRuby environment.
    Since:
    2.3

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractJRubyExecTask

Properties Summary

Constructor Summary

Methods Summary

Property Detail

JRubyEnvironmentInheritance inheritRubyEnv

Constructor Detail

protected AbstractJRubyExecTask(WorkerExecutor we)

Method Detail

@Override void exec()

@Input JRubyEnvironmentInheritance getInheritRubyEnv()

void setGemDirProvider(TaskProvider<? extends AbstractGemPrepareTask> task)

void setGemDirProvider(Provider<File> gdp)

void setInheritRubyEnv(JRubyEnvironmentInheritance mode)

protected void setJrubyJarProvider(Object provider)

@Override void withModuleOpens()

@Override void withSystemPath()