@NeverNull.ByDefault

Package net.bytebuddy.build

A package for types that allow for applying Byte Buddy transformation during a build process.

See: Description

Interface Summary

Interface	Description
AndroidDescriptor	Provides Android context information to Plugin instances that include it as their constructor parameter.
BuildLogger	An API that can be implemented by logging build systems to allow plugins to log information without depending on a build system-specific logging API.
EntryPoint	An entry point for a build tool which is responsible for the transformation's configuration.
Plugin	A plugin that allows for the application of Byte Buddy transformations during a build process.
Plugin.Engine	A plugin engine allows the application of one or more plugins on class files found at a Plugin.Engine.Source which are then transferred and consumed by a Target.
Plugin.Engine.Dispatcher	A dispatcher to execute a plugin engine transformation.
Plugin.Engine.Dispatcher.Factory	A factory that is used for creating a dispatcher that is used for a specific plugin engine application.
Plugin.Engine.Dispatcher.Materializable	The result of a work assignment that needs to be invoked from the main thread that triggers a dispatchers life-cycle methods.
Plugin.Engine.ErrorHandler	An error handler that is used during a plugin engine application.
Plugin.Engine.Listener	A listener that is invoked upon any event during a plugin engine application.
Plugin.Engine.PoolStrategy	A pool strategy determines the creation of a TypePool for a plugin engine application.
Plugin.Engine.Source	A source for a plugin engine provides binary elements to consider for transformation.
Plugin.Engine.Source.Element	Represents a binary element found in a source location.
Plugin.Engine.Source.Origin	An origin for elements.
Plugin.Engine.Target	A target for a plugin engine represents a sink container for all elements that are supplied by a Plugin.Engine.Source.
Plugin.Engine.Target.Sink	A sink represents an active writing process.
Plugin.Engine.TypeStrategy	A type strategy determines the transformation that is applied to a type description.
Plugin.Factory	A factory for providing a build plugin.
Plugin.Factory.UsingReflection.ArgumentResolver	Allows to resolve arguments for a Plugin constructor.
Plugin.Factory.UsingReflection.ArgumentResolver.Resolution	A resolution provided by an argument provider.
Plugin.Factory.UsingReflection.Instantiator	An instantiator is responsible for invoking a plugin constructor reflectively.
Plugin.WithInitialization	Allows for the generation of types before a plugin is applied.
Plugin.WithPreprocessor	A plugin that applies a preprocessor, i.e.
RenamingPlugin.Renaming	A renaming function tho transform a type's binary name.

Class Summary

Class	Description
AccessControllerPlugin	A build tool plugin that instruments methods to dispatch to methods java.security.AccessController with equal signature.
AccessControllerPlugin.AccessControlWrapper	An wrapper for a method that represents a method of AccessController which is weaved.
AccessControllerPlugin.AccessControlWrapper.PrefixingMethodVisitor	A method visitor to implement a weaved method to dispatch to an java.security.AccessController, if available.
AccessControllerPlugin.Initializer	A byte code appender to create an initializer segment that determines if the java.security.AccessController is available.
AccessControllerPlugin.Initializer.WithoutProperty	An initializer that always uses the access controller if it is available.
AccessControllerPlugin.Initializer.WithProperty	An initializer that uses a property to determine if the access controller should be actually used even if it is available.
BuildLogger.Adapter	An abstract adapter implementation for a build logger.
BuildLogger.Compound	A compound build logger.
BuildLogger.StreamWriting	A build logger that writes all statements to a PrintStream.
CachedReturnPlugin	A plugin that caches the return value of a method in a synthetic field.
CachedReturnPlugin.CacheFieldOffsetMapping	An offset mapping for the cached field.
DispatcherAnnotationPlugin	A plugin that adds a JavaDispatcher.Proxied annotation to any method of an enhanced type where the annotation is not set.
EntryPoint.Unvalidated	An entry point that wraps another entry point but disables validation.
HashCodeAndEqualsPlugin	A build tool plugin that adds Object.hashCode() and Object.equals(Object) methods to a class if the HashCodeAndEqualsPlugin.Enhance annotation is present and no explicit method declaration was added.
HashCodeAndEqualsPlugin.ValueMatcher	An element matcher for a HashCodeAndEqualsPlugin.ValueHandling annotation.
HashCodeAndEqualsPlugin.WithNonNullableFields	A version of the HashCodeAndEqualsPlugin that assumes that all fields are non-nullable unless they are explicitly marked.
Plugin.Engine.AbstractBase	An abstract base implementation of a plugin engine.
Plugin.Engine.Default	A default implementation of a plugin engine.
Plugin.Engine.Dispatcher.ForParallelTransformation	A dispatcher that applies transformations within one or more threads in parallel to the default transformer.
Plugin.Engine.Dispatcher.ForParallelTransformation.EagerWork	An eager materialization that does not defer processing after preprocessing.
Plugin.Engine.Dispatcher.ForParallelTransformation.Factory	A factory for a dispatcher that uses a given executor service for parallel dispatching.
Plugin.Engine.Dispatcher.ForParallelTransformation.WithThrowawayExecutorService	A parallel dispatcher that shuts down its executor service upon completion of a plugin engine's application.
Plugin.Engine.Dispatcher.ForParallelTransformation.WithThrowawayExecutorService.Factory	A factory for a parallel executor service that creates a new executor service on each plugin engine application.
Plugin.Engine.Dispatcher.ForSerialTransformation	A dispatcher that applies transformation upon discovery.
Plugin.Engine.Dispatcher.Materializable.ForFailedElement	A materializable for an element that failed to be transformed.
Plugin.Engine.Dispatcher.Materializable.ForRetainedElement	A materializable for an element that is retained in its original state.
Plugin.Engine.Dispatcher.Materializable.ForTransformedElement	A materializable for a successfully transformed type.
Plugin.Engine.Dispatcher.Materializable.ForUnresolvedElement	A materializable for an element that could not be resolved.
Plugin.Engine.ErrorHandler.Compound	A compound error handler.
Plugin.Engine.Listener.Adapter	An adapter that implements all methods non-operational.
Plugin.Engine.Listener.Compound	A compound listener.
Plugin.Engine.Listener.ForErrorHandler	A listener decorator that forwards events to an error handler if they are applicable.
Plugin.Engine.Listener.StreamWriting	A listener that forwards significant events of a plugin engine application to a PrintStream.
Plugin.Engine.Listener.WithErrorsOnly	A decorator for another listener to only print error events.
Plugin.Engine.Listener.WithTransformationsOnly	A decorator for another listener to only print transformation and error events.
Plugin.Engine.Source.Compound	A compound source that combines multiple sources into a single representation.
Plugin.Engine.Source.Compound.Origin	Implements a compound Plugin.Engine.Source.Origin.
Plugin.Engine.Source.Compound.Origin.CompoundIterator	A compound iterator that combines several iterables.
Plugin.Engine.Source.Element.ForByteArray	An element representation for a byte array.
Plugin.Engine.Source.Element.ForFile	An element representation for a file.
Plugin.Engine.Source.Element.ForJarEntry	Represents a jar file entry as an element.
Plugin.Engine.Source.Filtering	A source that applies a filter upon iterating elements.
Plugin.Engine.Source.ForFolder	Represents the contents of a folder as class files.
Plugin.Engine.Source.ForJarFile	Represents a jar file as a source.
Plugin.Engine.Source.InMemory	A source that represents a collection of in-memory resources that are represented as byte arrays.
Plugin.Engine.Source.InMemory.MapEntryIterator	An iterator that represents map entries as sources.
Plugin.Engine.Source.Origin.Filtering	An origin that forwards all invocations to a delegate where an ElementMatcher is applied prior to iteration.
Plugin.Engine.Source.Origin.ForJarFile	An origin implementation for a jar file.
Plugin.Engine.Summary	A summary of the application of a Plugin.Engine to a source and target.
Plugin.Engine.Target.ForFolder	Represents a folder as the target for a plugin engine's application.
Plugin.Engine.Target.ForJarFile	Represents a jar file as a target.
Plugin.Engine.Target.InMemory	A sink that stores all elements in a memory map.
Plugin.Engine.Target.Sink.ForJarOutputStream	Implements a sink for a jar file.
Plugin.Engine.TypeStrategy.ForEntryPoint	A type strategy that represents a given EntryPoint for a build tool.
Plugin.Factory.Simple	A simple factory that returns a preconstructed plugin instance.
Plugin.Factory.UsingReflection	A plugin factory that uses reflection for instantiating a plugin.
Plugin.Factory.UsingReflection.ArgumentResolver.ForIndex	An argument resolver that resolves an argument for a specific parameter index.
Plugin.Factory.UsingReflection.ArgumentResolver.ForIndex.WithDynamicType	An argument resolver that resolves an argument for a specific parameter index by attempting a conversion via invoking a static valueOf method on the target type, if it exists.
Plugin.Factory.UsingReflection.ArgumentResolver.ForType<T>	An argument resolver that resolves parameters for a given type.
Plugin.Factory.UsingReflection.ArgumentResolver.Resolution.Resolved	Represents a resolved argument resolution.
Plugin.Factory.UsingReflection.Instantiator.Ambiguous	Represents an ambiguously resolved instantiator.
Plugin.Factory.UsingReflection.Instantiator.Resolved	An instantiator that is resolved for a given constructor with arguments.
Plugin.Factory.UsingReflection.Instantiator.Unresolved	An instantiator that is not resolved for creating an instance.
Plugin.ForElementMatcher	An abstract base for a Plugin that matches types by a given ElementMatcher.
Plugin.NoOp	A non-operational plugin that does not instrument any type.
RenamingPlugin	A plugin that replaces names that are discovered in class files.
RenamingPlugin.Renaming.Compound	A compound renaming.
RenamingPlugin.Renaming.ForPattern	A renaming that renames types by a given regular expression.
RenamingPlugin.RenamingRemapper	An ASM Remapper to apply renamings.
RepeatedAnnotationPlugin	A plugin that allows for adding a java.lang.annotation.Repeatable annotation even if compiled prior to Java 8 which introduces this annotation.
RepeatedAnnotationPlugin.RepeatedAnnotationAppender	A type attribute appender that adds a repeated annotation for a target type.
ToStringPlugin	A build tool plugin that adds a Object.toString() and method to a class if the ToStringPlugin.Enhance annotation is present and no explicit method declaration was added.

Enum Summary

Enum	Description
AndroidDescriptor.Trivial	A trivial implementation of an AndroidDescriptor that returns a fixed value.
AndroidDescriptor.TypeScope	Describes the origin of a type within an Android project.
BuildLogger.NoOp	A non-operational build logger that discards all statements.
EntryPoint.Default	Default implementations for an entry point.
HashCodeAndEqualsPlugin.AnnotationOrderComparator	A comparator that arranges fields in the order of HashCodeAndEqualsPlugin.Sorted.
HashCodeAndEqualsPlugin.Enhance.InvokeSuper	A strategy for determining the base value of a hash code or equality contract.
HashCodeAndEqualsPlugin.ValueHandling.Sort	Determines how a field should be handled.
Plugin.Engine.Dispatcher.ForSerialTransformation.Factory	A factory for creating a serial dispatcher.
Plugin.Engine.ErrorHandler.Enforcing	An error handler that enforces certain properties of the transformation.
Plugin.Engine.ErrorHandler.Failing	An implementation of an error handler that fails the plugin engine application.
Plugin.Engine.Listener.NoOp	A non-operational listener.
Plugin.Engine.PoolStrategy.Default	A default implementation of a pool strategy where type descriptions are resolved lazily.
Plugin.Engine.PoolStrategy.Eager	A pool strategy that resolves type descriptions eagerly.
Plugin.Engine.Source.Empty	An empty source that does not contain any elements or a manifest.
Plugin.Engine.Target.Discarding	A sink that discards any entry.
Plugin.Engine.TypeStrategy.Default	Default implementations for type strategies.
Plugin.Factory.UsingReflection.ArgumentResolver.NoOp	An argument resolver that never resolves an argument.
Plugin.Factory.UsingReflection.ArgumentResolver.Resolution.Unresolved	Represents an unresolved argument resolution.
RenamingPlugin.Renaming.NoOp	A non-operational renaming.
ToStringPlugin.Enhance.Prefix	A strategy for defining a prefix.

Annotation Types Summary

Annotation Type	Description
AccessControllerPlugin.Enhance	Indicates that the annotated method represents a pseudo implementation of java.security.AccessController which can be weaved to dispatch to the access controller if this is possible on the current VM and not explicitly disabled on the current VM via a system property.
CachedReturnPlugin.CacheField	Indicates the field that stores the cached value.
CachedReturnPlugin.Enhance	Indicates methods that should be cached, i.e.
HashCodeAndEqualsPlugin.Enhance	Instructs the HashCodeAndEqualsPlugin to generate Object.hashCode() and Object.equals(Object) for the annotated class unless these methods are already declared explicitly.
HashCodeAndEqualsPlugin.Sorted	Determines the sort order of fields for the equality check when implementing the Object.equals(Object) method.
HashCodeAndEqualsPlugin.ValueHandling	Determines how a field should be used within generated hash code and equality methods.
Plugin.Factory.UsingReflection.Priority	Indicates that a constructor should be treated with a given priority if several constructors can be resolved.
RepeatedAnnotationPlugin.Enhance	Indicates that the annotated annotation should be repeatable by the supplied annotation.
ToStringPlugin.Enhance	Instructs the ToStringPlugin to generate a Object.toString() method for the annotated class unless this method is already declared explicitly.
ToStringPlugin.Exclude	Determines that the annotated field is excluded from a string representation of the ToStringPlugin.

Package net.bytebuddy.build Description

A package for types that allow for applying Byte Buddy transformation during a build process.