net.bytebuddy.build.gradle

Class AbstractByteBuddyTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

net.bytebuddy.build.gradle.AbstractByteBuddyTask

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>

Direct Known Subclasses:

ByteBuddyJarTask, ByteBuddySimpleTask, ByteBuddyTask

public abstract class AbstractByteBuddyTask
extends DefaultTask

An abstract Byte Buddy task implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractByteBuddyTask.ByteBuddySkippingUrlClassLoader A class loader that resolves a source set while still loading Byte Buddy classes from the Gradle plugin.
protected static class	AbstractByteBuddyTask.TransformationLogger A Plugin.Engine.Listener that logs several relevant events during the build.

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

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

Modifier	Constructor and Description
protected	AbstractByteBuddyTask() Creates a new abstract Byte Buddy task.

Method Summary

Modifier and Type	Method and Description
protected abstract Iterable<File>	classPath() Returns the class path to supply to the plugin engine.
protected static boolean	deleteRecursively(File file) Deletes a file or a folder recursively.
protected static boolean	deleteRecursively(Iterable<File> files) Deletes a collection of files or a folders recursively.
protected abstract Iterable<File>	discoverySet() Returns the discovery class path or null if not specified.
protected void	doApply(Plugin.Engine.Source source, Plugin.Engine.Target target) Applies the transformation from a source to a target.
ClassFileVersion	getClassFileVersion() Returns the class file version to use for creating auxiliary types or null if the version is determined implicitly.
Discovery	getDiscovery() Determines the discovery for finding plugins on the class path.
EntryPoint	getEntryPoint() Returns the entry point to use.
String	getSuffix() Returns the suffix to use for rebased methods or the empty string if a random suffix should be used.
int	getThreads() Returns the number of threads to use for transforming or 0 if the transformation should be applied in the main thread.
List<Transformation>	getTransformations() Returns the transformations to apply.
boolean	isExtendedParsing() Returns true if extended parsing should be used.
boolean	isFailFast() Returns true if a warning should be issued for an empty type set.
boolean	isFailOnLiveInitializer() Returns true if the transformation should fail if a live initializer is used.
boolean	isWarnOnEmptyTypeSet() Returns true if a warning should be issued for an empty type set.
void	setClassFileVersion(ClassFileVersion classFileVersion) Sets the class file version to use for creating auxiliary types or null if the version is determined implicitly.
void	setDiscovery(Discovery discovery) Determines the discovery being used for finding plugins on the class path.
void	setEntryPoint(EntryPoint entryPoint) Sets the entry point to use.
void	setExtendedParsing(boolean extendedParsing) Determines if extended parsing should be used.
void	setFailFast(boolean failFast) Determines if a warning should be issued for an empty type set.
void	setFailOnLiveInitializer(boolean failOnLiveInitializer) Determines if the transformation should fail if a live initializer is used.
void	setSuffix(String suffix) Sets the suffix to use for rebased methods or the empty string if a random suffix should be used.
void	setThreads(int threads) Sets the number of threads to use for transforming or 0 if the transformation should be applied in the main thread.
void	setWarnOnEmptyTypeSet(boolean warnOnEmptyTypeSet) Returns true if a warning should be issued for an empty type set.
protected abstract File	source() Returns the source file or folder.
protected abstract File	target() Returns the target file or folder.
void	transformation(Action<Transformation> action) Adds an additional transformation.
void	transformation(groovy.lang.Closure<Transformation> closure) Adds an additional transformation.

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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

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

AbstractByteBuddyTask

protected AbstractByteBuddyTask()

Creates a new abstract Byte Buddy task.

Method Detail

getTransformations

public List<Transformation> getTransformations()

Returns the transformations to apply.

Returns:

The transformations to apply.

transformation

public void transformation(groovy.lang.Closure<Transformation> closure)

Adds an additional transformation.

Parameters:

closure - The closure to configure the transformation.

transformation

public void transformation(Action<Transformation> action)

Adds an additional transformation.

Parameters:

action - The action to configure the transformation.

getEntryPoint

@Input
public EntryPoint getEntryPoint()

Returns the entry point to use.

Returns:

The entry point to use.

setEntryPoint

public void setEntryPoint(EntryPoint entryPoint)

Sets the entry point to use.

Parameters:

entryPoint - The entry point to use.

getSuffix

@Input
public String getSuffix()

Returns the suffix to use for rebased methods or the empty string if a random suffix should be used.

Returns:

The suffix to use for rebased methods or the empty string if a random suffix should be used.

setSuffix

public void setSuffix(String suffix)

Sets the suffix to use for rebased methods or the empty string if a random suffix should be used.

Parameters:

suffix - The suffix to use for rebased methods or the empty string if a random suffix should be used.

isFailOnLiveInitializer

@Internal
public boolean isFailOnLiveInitializer()

Returns true if the transformation should fail if a live initializer is used.

Returns:

true if the transformation should fail if a live initializer is used.

setFailOnLiveInitializer

public void setFailOnLiveInitializer(boolean failOnLiveInitializer)

Determines if the transformation should fail if a live initializer is used.

Parameters:

failOnLiveInitializer - true if the transformation should fail if a live initializer is used.

isWarnOnEmptyTypeSet

@Internal
public boolean isWarnOnEmptyTypeSet()

Returns true if a warning should be issued for an empty type set.

Returns:

true if a warning should be issued for an empty type set.

setWarnOnEmptyTypeSet

public void setWarnOnEmptyTypeSet(boolean warnOnEmptyTypeSet)

Returns true if a warning should be issued for an empty type set.

Parameters:

warnOnEmptyTypeSet - true if a warning should be issued for an empty type set.

isFailFast

@Internal
public boolean isFailFast()

Returns true if a warning should be issued for an empty type set.

Returns:

true if a warning should be issued for an empty type set.

setFailFast

public void setFailFast(boolean failFast)

Determines if a warning should be issued for an empty type set.

Parameters:

failFast - true if a warning should be issued for an empty type set.

isExtendedParsing

@Input
public boolean isExtendedParsing()

Returns true if extended parsing should be used.

Returns:

true if extended parsing should be used.

setExtendedParsing

public void setExtendedParsing(boolean extendedParsing)

Determines if extended parsing should be used.

Parameters:

extendedParsing - true if extended parsing should be used.

getDiscovery

@Input
public Discovery getDiscovery()

Determines the discovery for finding plugins on the class path.

Returns:

The discovery for finding plugins on the class path.

setDiscovery

public void setDiscovery(Discovery discovery)

Determines the discovery being used for finding plugins on the class path.

Parameters:

discovery - The discovery for finding plugins on the class path.

getThreads

@Internal
public int getThreads()

Returns the number of threads to use for transforming or 0 if the transformation should be applied in the main thread.

Returns:

The number of threads to use for transforming or 0 if the transformation should be applied in the main thread.

setThreads

public void setThreads(int threads)

Sets the number of threads to use for transforming or 0 if the transformation should be applied in the main thread.

Parameters:

threads - The number of threads to use for transforming or 0 if the transformation should be applied in the main thread.

getClassFileVersion

@MaybeNull
 @Input
 @Optional
public ClassFileVersion getClassFileVersion()

Returns the class file version to use for creating auxiliary types or null if the version is determined implicitly.

Returns:

The class file version to use for creating auxiliary types.

setClassFileVersion

public void setClassFileVersion(@MaybeNull
                                ClassFileVersion classFileVersion)

Sets the class file version to use for creating auxiliary types or null if the version is determined implicitly.

Parameters:

classFileVersion - The class file version to use for creating auxiliary types.

source

protected abstract File source()

Returns the source file or folder.

Returns:

The source file or folder.

target

protected abstract File target()

Returns the target file or folder.

Returns:

The target file or folder.

classPath

protected abstract Iterable<File> classPath()

Returns the class path to supply to the plugin engine.

Returns:

The class path to supply to the plugin engine.

discoverySet

@MaybeNull
protected abstract Iterable<File> discoverySet()

Returns the discovery class path or null if not specified.

Returns:

The discovery class path or null if not specified.

doApply

protected void doApply(Plugin.Engine.Source source,
                       Plugin.Engine.Target target)
                throws IOException

Applies the transformation from a source to a target.

Parameters:

source - The plugin engine's source.

target - The plugin engine's target.

Throws:

IOException - If an I/O exception occurs.

deleteRecursively

protected static boolean deleteRecursively(Iterable<File> files)

Deletes a collection of files or a folders recursively.

Parameters:

files - The files or folders to delete.

Returns:

true if any of the files or folders were deleted.

deleteRecursively

protected static boolean deleteRecursively(File file)

Deletes a file or a folder recursively.

Parameters:

file - The file or folder to delete.

Returns:

true if the file or folders were deleted.