io.github.iwakoshi.jandex

Class JandexTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

io.github.iwakoshi.jandex.JandexTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public abstract class JandexTask
extends org.gradle.api.DefaultTask

Gradle task that generates a Jandex index for a given set of class directories. Uses the Gradle Worker API with classloader isolation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
JandexTask()

Method Summary

Modifier and Type	Method and Description
void	generateIndex() Executes the Jandex indexing via the Worker API.
abstract org.gradle.api.file.ConfigurableFileCollection	getClassesDirs() The directories containing the class files to index.
abstract org.gradle.api.provider.Property<java.lang.Integer>	getIndexVersion() The version of the Jandex index format to use.
abstract org.gradle.api.file.ConfigurableFileCollection	getJandexClasspath() The classpath containing the io.smallrye:jandex library.
abstract org.gradle.api.file.RegularFileProperty	getOutputFile() The file path to the Jandex index file to be generated.
abstract org.gradle.workers.WorkerExecutor	getWorkerExecutor()

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

JandexTask

public JandexTask()

Method Detail

getClassesDirs

@InputFiles
 @SkipWhenEmpty
 @PathSensitive(value=RELATIVE)
public abstract org.gradle.api.file.ConfigurableFileCollection getClassesDirs()

The directories containing the class files to index. When empty, the task will not run.

Returns:

the classes directories file collection

getJandexClasspath

@Classpath
public abstract org.gradle.api.file.ConfigurableFileCollection getJandexClasspath()

The classpath containing the io.smallrye:jandex library. Resolved from a detached configuration at configuration time.

Returns:

the jandex classpath file collection

getOutputFile

@OutputFile
public abstract org.gradle.api.file.RegularFileProperty getOutputFile()

The file path to the Jandex index file to be generated.

Returns:

the output file property

getIndexVersion

@Input
 @Optional
public abstract org.gradle.api.provider.Property<java.lang.Integer> getIndexVersion()

The version of the Jandex index format to use. When unset, the latest version supported by the used Jandex version is used. Set this to an older version (e.g. 6) for compatibility with readers that don't support the latest format. Value must be >= 6.

Returns:

the index version property

getWorkerExecutor

@Inject
public abstract org.gradle.workers.WorkerExecutor getWorkerExecutor()

generateIndex

public void generateIndex()

Executes the Jandex indexing via the Worker API.