AbstractGemPrepareTask (jrubygradle-resolver 2.3.2 API)

org.ysb33r.gradle.jruby.api.tasks.AbstractGemPrepareTask

All Implemented Interfaces and Traits:

GemPrepareTask
```
@groovy.transform.CompileStatic
class AbstractGemPrepareTask
extends org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask
implements GemPrepareTask
```
Abstract base class for building custom tasks for preparing GEMs.
Authors:
Schalk W. Cronjé
R Tyler Croy
Christian Meier

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AbstractGemPrepareTask.1`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`JRUBY_COMPLETE_NAME`

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	`__$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`GemOverwriteAction`	`gemOverwriteAction`
`Provider<File>`	`outputDir`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exec()`
	`void`	`forkOptions(Action<org.ysb33r.grolifant5.api.core.jvm.GrolifantSimpleSetJavaForkOptions> configurator)` Configures the fork options for the task.
	`void`	`forkOptions(groovy.lang.Closure<?> configurator)` Configures the fork options for the task.
	`GemOverwriteAction`	`getGemOverwriteAction()` The overwrite action to use for GEMs.
	`FileCollection`	`getGemsAndJarsAsFileCollection()`
	`Provider<File>`	`getOutputDir()` Target directory for GEMs.
	`void`	`noConfigurationCache()`
	`void`	`setAwaitMode(Boolean aBoolean)`
	`void`	`setGemConfiguration(Configuration configurationProvider)` Sets the GEM configuration to be used with this task.
	`void`	`setGemOverwriteAction(GemOverwriteAction action)`
	`protected void`	`setJrubyJarProvider(Object provider)` Location of `jruby-complete` JAR.
	`void`	`setOutputDir(Object f)` Sets the output directory
	`void`	`withModuleOpens()` Shortcut to open modules when needed for execution.
	`void`	`withSystemPath()` Shortcut to ensure system path is added to JRuby environment.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#execTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#projectTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#providerTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#fsOperations(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#jvmTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#stringTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#problemReporter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMetaClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getName(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(org.gradle.api.Task), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogger(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#property(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getExtensions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDescription(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDir(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#mustRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMustRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMustRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#finalizedBy([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setFinalizedBy(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getFinalizedBy(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#shouldRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setShouldRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getShouldRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#usesService(org.gradle.api.provider.Provider), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getGroup(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setGroup(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAnt(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogging(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDependsOn(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDependsOn(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDidWork(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setActions(java.util.List), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#dependsOn([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDidWork(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDestroyables(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLocalState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTimeout(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setEnabled(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDescription(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAsDynamicObject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getConvention(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notCompatibleWithConfigurationCache(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doNotTrackState(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getIdentityPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getSharedResources(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getStandardOutputCapture(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#acceptServiceReferences(java.util.Set), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskIdentity(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOnlyIf(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonNotToTrackState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isCompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonTaskIsIncompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getImpliesSubProjects(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setImpliesSubProjects(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDirFactory(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isHasCustomActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getRequiredServices(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#equals(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#toString(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hashCode(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notify(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notifyAll(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long, int), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#invokeMethod(java.lang.String, java.lang.Object)

- Field Detail
  - public static final String JRUBY_COMPLETE_NAME
- Property Detail
  - GemOverwriteAction gemOverwriteAction
  - Provider<File> outputDir
- Constructor Detail
  - protected AbstractGemPrepareTask(WorkerExecutor we)
- Method Detail
  - @TaskAction void exec()
  - @Override void forkOptions(Action<org.ysb33r.grolifant5.api.core.jvm.GrolifantSimpleSetJavaForkOptions> configurator)
    
    Configures the fork options for the task.
    Parameters:
    configurator - Configurator.
    Since:
    2.3
  - @Override void forkOptions(@groovy.lang.DelegatesTo(value: GrolifantSimpleSetJavaForkOptions) groovy.lang.Closure<?> configurator)
    
    Configures the fork options for the task.
    Parameters:
    configurator - Configurator.
    Since:
    2.3
  - @Internal GemOverwriteAction getGemOverwriteAction()
    
    The overwrite action to use for GEMs.
    Returns:
    Overwrite action.
  - @Override FileCollection getGemsAndJarsAsFileCollection()
  - @Override Provider<File> getOutputDir()
    
    Target directory for GEMs. Extracted GEMs will end up in outputDir + "/gems"
    Returns:
    Provider to a destination directory
  - @groovy.transform.CompileDynamic void noConfigurationCache()
  - @Override void setAwaitMode(Boolean aBoolean)
  - @Override void setGemConfiguration(Configuration configurationProvider)
    
    Sets the GEM configuration to be used with this task.
    Parameters:
    configurationProvider - File collection
  - @Override void setGemOverwriteAction(GemOverwriteAction action)
  - 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 setOutputDir(Object f)
    
    Sets the output directory
    Parameters:
    f - Output directory
  - @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

Groovy Documentation

[Groovy] Class AbstractGemPrepareTask

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String JRUBY_COMPLETE_NAME

Property Detail

GemOverwriteAction gemOverwriteAction

Provider<File> outputDir

Constructor Detail

protected AbstractGemPrepareTask(WorkerExecutor we)

Method Detail

@TaskAction void exec()

@Override void forkOptions(Action<org.ysb33r.grolifant5.api.core.jvm.GrolifantSimpleSetJavaForkOptions> configurator)

@Override void forkOptions(@groovy.lang.DelegatesTo(value: GrolifantSimpleSetJavaForkOptions) groovy.lang.Closure<?> configurator)

@Internal GemOverwriteAction getGemOverwriteAction()

@Override FileCollection getGemsAndJarsAsFileCollection()

@Override Provider<File> getOutputDir()

@groovy.transform.CompileDynamic void noConfigurationCache()

@Override void setAwaitMode(Boolean aBoolean)

@Override void setGemConfiguration(Configuration configurationProvider)

@Override void setGemOverwriteAction(GemOverwriteAction action)

protected void setJrubyJarProvider(Object provider)

@Override void setOutputDir(Object f)

@Override void withModuleOpens()

@Override void withSystemPath()