net.bytebuddy.dynamic

Class DynamicType.Builder.AbstractBase.AbstractDelegatingBuilder<U>

java.lang.Object

net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase.AbstractDelegatingBuilder<U>

Type Parameters:

U - The most specific known loaded type that is implemented by the created dynamic type, usually the type itself, an interface or the direct super class.

All Implemented Interfaces:

DynamicType.Builder<U>

Enclosing class:

DynamicType.Builder.AbstractBase<S>

protected abstract class DynamicType.Builder.AbstractBase.AbstractDelegatingBuilder<U>
extends Object
implements DynamicType.Builder<U>

A base implementation of a builder that is capable of manifesting a change that was not yet applied to the builder.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.DynamicType.Builder

DynamicType.Builder.AbstractBase<S>, DynamicType.Builder.ExceptionDeclarableMethodInterception<S>, DynamicType.Builder.FieldAnnotationTarget<S>, DynamicType.Builder.MatchedMethodInterception<T>, DynamicType.Builder.MethodAnnotationTarget<S>, DynamicType.Builder.OptionalMatchedMethodInterception<S>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDelegatingBuilder()

Method Summary

Modifier and Type	Method and Description
DynamicType.Builder<U>	annotateType(Annotation... annotation) Adds annotations to the currently constructed type.
DynamicType.Builder<U>	attribute(TypeAttributeAppender attributeAppender) Adds an attribute appender to the currently constructed type which will be applied on the creation of the type.
DynamicType.Builder<U>	classFormatVersion(ClassFileVersion classFileVersion) Defines a class file format version for this builder for which the dynamic types should be created.
DynamicType.Builder<U>	classVisitor(ClassVisitorWrapper classVisitorWrapper) Adds an additional ASM ClassVisitor to this builder which will be applied in the construction process of this dynamic type.
DynamicType.Builder.MatchedMethodInterception<U>	constructor(MethodMatcher methodMatcher) Selects a set of constructors of this type for instrumentation.
DynamicType.Builder.ExceptionDeclarableMethodInterception<U>	defineConstructor(Iterable<Class<?>> parameterTypes, ModifierContributor.ForMethod... modifier) Defines a new constructor for this type.
DynamicType.Builder.ExceptionDeclarableMethodInterception<U>	defineConstructor(List<? extends TypeDescription> parameterTypes, ModifierContributor.ForMethod... modifier) Defines a new constructor for this type.
DynamicType.Builder.FieldAnnotationTarget<U>	defineField(String name, Class<?> fieldType, ModifierContributor.ForField... modifier) Defines a new field for this type.
DynamicType.Builder.FieldAnnotationTarget<U>	defineField(String name, TypeDescription fieldTypeDescription, ModifierContributor.ForField... modifier) Defines a new field for this type.
DynamicType.Builder.ExceptionDeclarableMethodInterception<U>	defineMethod(String name, Class<?> returnType, List<Class<?>> parameterTypes, ModifierContributor.ForMethod... modifier) Defines a new method for this type.
DynamicType.Builder.ExceptionDeclarableMethodInterception<U>	defineMethod(String name, TypeDescription returnType, List<? extends TypeDescription> parameterTypes, ModifierContributor.ForMethod... modifier) Defines a new method for this type.
DynamicType.Builder<U>	ignoreMethods(MethodMatcher ignoredMethods) Defines a matcher for methods that will be ignored for any interception attempt.
DynamicType.Builder.OptionalMatchedMethodInterception<U>	implement(Class<?> interfaceType) Adds an interface to be implemented the created type.
DynamicType.Builder.OptionalMatchedMethodInterception<U>	implement(TypeDescription interfaceType) Adds an interface to be implemented the created type.
DynamicType.Builder.MatchedMethodInterception<U>	invokable(MethodMatcher methodMatcher) Selects a set of byte code methods of this type for instrumentation.
DynamicType.Unloaded<U>	make() Creates the dynamic type without loading it.
protected abstract DynamicType.Builder<U>	materialize() Materializes the current state of the build before applying another modification.
DynamicType.Builder.MatchedMethodInterception<U>	method(MethodMatcher methodMatcher) Selects a set of methods of this type for instrumentation.
DynamicType.Builder<U>	modifiers(ModifierContributor.ForType... modifier) Defines modifiers for the created dynamic type.
DynamicType.Builder<U>	name(String name) Names the currently created dynamic type by a fixed name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDelegatingBuilder

protected AbstractDelegatingBuilder()

Method Detail

classFormatVersion

public DynamicType.Builder<U> classFormatVersion(ClassFileVersion classFileVersion)

Description copied from interface: DynamicType.Builder

Defines a class file format version for this builder for which the dynamic types should be created.

Specified by:

classFormatVersion in interface DynamicType.Builder<U>

Parameters:

classFileVersion - The class format version for the dynamic type to implement.

Returns:

A builder that writes its classes in a given class format version.

implement

public DynamicType.Builder.OptionalMatchedMethodInterception<U> implement(Class<?> interfaceType)

Description copied from interface: DynamicType.Builder

Adds an interface to be implemented the created type.

Specified by:

implement in interface DynamicType.Builder<U>

Parameters:

interfaceType - The interface to implement.

Returns:

A builder which will create a dynamic type that implements the given interface.

implement

public DynamicType.Builder.OptionalMatchedMethodInterception<U> implement(TypeDescription interfaceType)

Description copied from interface: DynamicType.Builder

Adds an interface to be implemented the created type.

Specified by:

implement in interface DynamicType.Builder<U>

Parameters:

interfaceType - A description of the interface to implement.

Returns:

A builder which will create a dynamic type that implements the given interface.

name

public DynamicType.Builder<U> name(String name)

Description copied from interface: DynamicType.Builder

Names the currently created dynamic type by a fixed name.

Specified by:

name in interface DynamicType.Builder<U>

Parameters:

name - A fully qualified name to give to the created dynamic type.

Returns:

A builder that will name its dynamic type by the given name.

modifiers

public DynamicType.Builder<U> modifiers(ModifierContributor.ForType... modifier)

Description copied from interface: DynamicType.Builder

Defines modifiers for the created dynamic type.

Specified by:

modifiers in interface DynamicType.Builder<U>

Parameters:

modifier - A collection of modifiers to be reflected by the created dynamic type.

Returns:

A builder that will create a dynamic type that reflects the given modifiers.

ignoreMethods

public DynamicType.Builder<U> ignoreMethods(MethodMatcher ignoredMethods)

Description copied from interface: DynamicType.Builder

Defines a matcher for methods that will be ignored for any interception attempt. Any methods that were directly declared on an instrumented type will never be ignored, i.e. ignored methods only represent a filter for methods that are declared in super types that should never be overriden.

Specified by:

ignoreMethods in interface DynamicType.Builder<U>

Parameters:

ignoredMethods - A method matcher characterizing the methods to be ignored.

Returns:

A builder that will always ignore the methods matched by the given method matcher.

attribute

public DynamicType.Builder<U> attribute(TypeAttributeAppender attributeAppender)

Description copied from interface: DynamicType.Builder

Adds an attribute appender to the currently constructed type which will be applied on the creation of the type.

Specified by:

attribute in interface DynamicType.Builder<U>

Parameters:

attributeAppender - An attribute appender to be applied onto the currently created type.

Returns:

A builder that will apply the given attribute appender onto the currently created type.

annotateType

public DynamicType.Builder<U> annotateType(Annotation... annotation)

Description copied from interface: DynamicType.Builder

Adds annotations to the currently constructed type.

Note: The annotations will not be visible to Instrumentations.

Specified by:

annotateType in interface DynamicType.Builder<U>

Parameters:

annotation - The annotations to be added to the currently constructed type.

Returns:

A builder that will add the given annotation to the created type.

classVisitor

public DynamicType.Builder<U> classVisitor(ClassVisitorWrapper classVisitorWrapper)

Description copied from interface: DynamicType.Builder

Adds an additional ASM ClassVisitor to this builder which will be applied in the construction process of this dynamic type.

Specified by:

classVisitor in interface DynamicType.Builder<U>

Parameters:

classVisitorWrapper - The wrapper delegate for the ASM class visitor.

Returns:

A builder that will apply the given ASM class visitor.

defineField

public DynamicType.Builder.FieldAnnotationTarget<U> defineField(String name,
                                                                Class<?> fieldType,
                                                                ModifierContributor.ForField... modifier)

Description copied from interface: DynamicType.Builder

Defines a new field for this type.

Specified by:

defineField in interface DynamicType.Builder<U>

Parameters:

name - The name of the method.

fieldType - The type of this field where the current type can be represented by TargetType.

modifier - The modifiers for this method.

Returns:

An interception delegate that exclusively matches the new method.

defineField

public DynamicType.Builder.FieldAnnotationTarget<U> defineField(String name,
                                                                TypeDescription fieldTypeDescription,
                                                                ModifierContributor.ForField... modifier)

Description copied from interface: DynamicType.Builder

Defines a new field for this type.

Specified by:

defineField in interface DynamicType.Builder<U>

Parameters:

name - The name of the method.

fieldTypeDescription - The type of this field where the current type can be represented by TargetType.

modifier - The modifiers for this method.

Returns:

An interception delegate that exclusively matches the new method.

defineMethod

public DynamicType.Builder.ExceptionDeclarableMethodInterception<U> defineMethod(String name,
                                                                                 Class<?> returnType,
                                                                                 List<Class<?>> parameterTypes,
                                                                                 ModifierContributor.ForMethod... modifier)

Description copied from interface: DynamicType.Builder

Defines a new method for this type.

Note that a method definition will shadow any method of identical signature that was defined in a super class. This implies that the defined method will be treated as if it does not have a super implementation.

Specified by:

defineMethod in interface DynamicType.Builder<U>

Parameters:

name - The name of the method.

returnType - The return type of the method where the current type can be represented by TargetType.

parameterTypes - The parameter types of this method where the current type can be represented by TargetType.

modifier - The modifiers for this method.

Returns:

An interception delegate that exclusively matches the new method.

defineMethod

public DynamicType.Builder.ExceptionDeclarableMethodInterception<U> defineMethod(String name,
                                                                                 TypeDescription returnType,
                                                                                 List<? extends TypeDescription> parameterTypes,
                                                                                 ModifierContributor.ForMethod... modifier)

Description copied from interface: DynamicType.Builder

Defines a new method for this type.

Note that a method definition will shadow any method of identical signature that was defined in a super class. This implies that the defined method will be treated as if it does not have a super implementation.

Specified by:

defineMethod in interface DynamicType.Builder<U>

Parameters:

name - The name of the method.

returnType - A description of the return type of the method where the current type can be represented by TargetType.

parameterTypes - Descriptions of the parameter types of this method where the current type can be represented by TargetType.

modifier - The modifiers for this method.

Returns:

An interception delegate that exclusively matches the new method.

defineConstructor

public DynamicType.Builder.ExceptionDeclarableMethodInterception<U> defineConstructor(Iterable<Class<?>> parameterTypes,
                                                                                      ModifierContributor.ForMethod... modifier)

Description copied from interface: DynamicType.Builder

Defines a new constructor for this type.

Note that a constructor's implementation must call another constructor of the same class or a constructor of its super class. This constructor call must be hardcoded inside of the constructor's method body. Before this constructor call is made, it is not legal to call any methods or to read any fields of the instance under construction.

Specified by:

defineConstructor in interface DynamicType.Builder<U>

Parameters:

parameterTypes - The parameter types of this constructor where the current type can be represented by TargetType.

modifier - The modifiers for this constructor.

Returns:

An interception delegate that exclusively matches the new constructor.

defineConstructor

public DynamicType.Builder.ExceptionDeclarableMethodInterception<U> defineConstructor(List<? extends TypeDescription> parameterTypes,
                                                                                      ModifierContributor.ForMethod... modifier)

Description copied from interface: DynamicType.Builder

Defines a new constructor for this type.

Note that a constructor's implementation must call another constructor of the same class or a constructor of its super class. This constructor call must be hardcoded inside of the constructor's method body. Before this constructor call is made, it is not legal to call any methods or to read any fields of the instance under construction.

Specified by:

defineConstructor in interface DynamicType.Builder<U>

Parameters:

parameterTypes - The descriptions of the parameter types of this constructor where the current type can be represented by a description of TargetType.

modifier - The modifiers for this constructor.

Returns:

An interception delegate that exclusively matches the new constructor.

method

public DynamicType.Builder.MatchedMethodInterception<U> method(MethodMatcher methodMatcher)

Description copied from interface: DynamicType.Builder

Selects a set of methods of this type for instrumentation.

Specified by:

method in interface DynamicType.Builder<U>

Parameters:

methodMatcher - A matcher describing the methods to be intercepted by this instrumentation.

Returns:

An interception delegate for methods matching the given method matcher.

constructor

public DynamicType.Builder.MatchedMethodInterception<U> constructor(MethodMatcher methodMatcher)

Description copied from interface: DynamicType.Builder

Selects a set of constructors of this type for instrumentation.

Specified by:

constructor in interface DynamicType.Builder<U>

Parameters:

methodMatcher - A matcher describing the constructors to be intercepted by this instrumentation.

Returns:

An interception delegate for constructors matching the given method matcher.

invokable

public DynamicType.Builder.MatchedMethodInterception<U> invokable(MethodMatcher methodMatcher)

Description copied from interface: DynamicType.Builder

Selects a set of byte code methods of this type for instrumentation.

Specified by:

invokable in interface DynamicType.Builder<U>

Parameters:

methodMatcher - A matcher describing the byte code methods to be intercepted by this instrumentation.

Returns:

An interception delegate for byte code methods matching the given method matcher.

make

public DynamicType.Unloaded<U> make()

Description copied from interface: DynamicType.Builder

Creates the dynamic type without loading it.

Specified by:

make in interface DynamicType.Builder<U>

Returns:

An unloaded representation of the dynamic type.

materialize

protected abstract DynamicType.Builder<U> materialize()

Materializes the current state of the build before applying another modification.

Returns:

A builder with all pending changes materialized.