net.bytebuddy.dynamic.scaffold.subclass

Class SubclassDynamicTypeBuilder<T>

java.lang.Object

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

net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase.Adapter<T>

net.bytebuddy.dynamic.scaffold.subclass.SubclassDynamicTypeBuilder<T>

Type Parameters:

T - A loaded type that the dynamic type is guaranteed to be a subtype of.

All Implemented Interfaces:

DynamicType.Builder<T>

@HashCodeAndEqualsPlugin.Enhance
public class SubclassDynamicTypeBuilder<T>
extends DynamicType.Builder.AbstractBase.Adapter<T>

A type builder that creates an instrumented type as a subclass, i.e. a type that is not based on an existing class file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SubclassDynamicTypeBuilder.InstrumentableMatcher A matcher that locates all methods that are overridable and not ignored or that are directly defined on the instrumented type.

Nested classes/interfaces inherited from class net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase.Adapter

DynamicType.Builder.AbstractBase.Adapter.FieldDefinitionAdapter, DynamicType.Builder.AbstractBase.Adapter.FieldMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.InnerTypeDefinitionForMethodAdapter, DynamicType.Builder.AbstractBase.Adapter.InnerTypeDefinitionForTypeAdapter, DynamicType.Builder.AbstractBase.Adapter.MethodDefinitionAdapter, DynamicType.Builder.AbstractBase.Adapter.MethodMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.OptionalMethodMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.RecordComponentDefinitionAdapter, DynamicType.Builder.AbstractBase.Adapter.RecordComponentMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.TypeVariableDefinitionAdapter

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

DynamicType.Builder.AbstractBase.Adapter<U>, DynamicType.Builder.AbstractBase.Delegator<U>

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

DynamicType.Builder.AbstractBase<S>, DynamicType.Builder.FieldDefinition<S>, DynamicType.Builder.InnerTypeDefinition<S>, DynamicType.Builder.MethodDefinition<S>, DynamicType.Builder.RecordComponentDefinition<S>, DynamicType.Builder.TypeVariableDefinition<S>

Field Summary

Fields inherited from class net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase.Adapter

annotationRetention, annotationValueFilterFactory, asmVisitorWrapper, auxiliaryTypeNamingStrategy, auxiliaryTypes, classFileVersion, classWriterStrategy, fieldRegistry, ignoredMethods, implementationContextFactory, instrumentedType, methodGraphCompiler, methodRegistry, recordComponentRegistry, typeAttributeAppender, typeValidation, visibilityBridgeStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SubclassDynamicTypeBuilder(InstrumentedType.WithFlexibleName instrumentedType, ClassFileVersion classFileVersion, AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy, AnnotationValueFilter.Factory annotationValueFilterFactory, AnnotationRetention annotationRetention, Implementation.Context.Factory implementationContextFactory, MethodGraph.Compiler methodGraphCompiler, TypeValidation typeValidation, VisibilityBridgeStrategy visibilityBridgeStrategy, ClassWriterStrategy classWriterStrategy, LatentMatcher<? super MethodDescription> ignoredMethods, ConstructorStrategy constructorStrategy) Creates a new type builder for creating a subclass.
protected	SubclassDynamicTypeBuilder(InstrumentedType.WithFlexibleName instrumentedType, FieldRegistry fieldRegistry, MethodRegistry methodRegistry, RecordComponentRegistry recordComponentRegistry, TypeAttributeAppender typeAttributeAppender, AsmVisitorWrapper asmVisitorWrapper, ClassFileVersion classFileVersion, AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy, AnnotationValueFilter.Factory annotationValueFilterFactory, AnnotationRetention annotationRetention, Implementation.Context.Factory implementationContextFactory, MethodGraph.Compiler methodGraphCompiler, TypeValidation typeValidation, VisibilityBridgeStrategy visibilityBridgeStrategy, ClassWriterStrategy classWriterStrategy, LatentMatcher<? super MethodDescription> ignoredMethods, List<? extends DynamicType> auxiliaryTypes, ConstructorStrategy constructorStrategy) Creates a new type builder for creating a subclass.

Method Summary

Modifier and Type	Method and Description
DynamicType.Unloaded<T>	make(TypeResolutionStrategy typeResolutionStrategy) Creates the dynamic type this builder represents.
DynamicType.Unloaded<T>	make(TypeResolutionStrategy typeResolutionStrategy, TypePool typePool) Creates the dynamic type this builder represents.
protected DynamicType.Builder<T>	materialize(InstrumentedType.WithFlexibleName instrumentedType, FieldRegistry fieldRegistry, MethodRegistry methodRegistry, RecordComponentRegistry recordComponentRegistry, TypeAttributeAppender typeAttributeAppender, AsmVisitorWrapper asmVisitorWrapper, ClassFileVersion classFileVersion, AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy, AnnotationValueFilter.Factory annotationValueFilterFactory, AnnotationRetention annotationRetention, Implementation.Context.Factory implementationContextFactory, MethodGraph.Compiler methodGraphCompiler, TypeValidation typeValidation, VisibilityBridgeStrategy visibilityBridgeStrategy, ClassWriterStrategy classWriterStrategy, LatentMatcher<? super MethodDescription> ignoredMethods, List<? extends DynamicType> auxiliaryTypes) Materializes the supplied state of a dynamic type builder.

Methods inherited from class net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase.Adapter

annotateType, attribute, declaredTypes, defineConstructor, defineField, defineMethod, defineRecordComponent, field, ignoreAlso, implement, initializer, initializer, innerTypeOf, innerTypeOf, invokable, merge, modifiers, name, nestHost, nestMembers, permittedSubclass, recordComponent, require, suffix, topLevelType, toTypeDescription, transform, typeVariable, unsealed, visit

Methods inherited from class net.bytebuddy.dynamic.DynamicType.Builder.AbstractBase

annotateType, annotateType, annotateType, constructor, declaredTypes, declaredTypes, declaredTypes, define, define, define, define, define, define, defineConstructor, defineConstructor, defineField, defineField, defineField, defineField, defineField, defineMethod, defineMethod, defineMethod, defineMethod, defineMethod, defineProperty, defineProperty, defineProperty, defineProperty, defineRecordComponent, field, ignoreAlso, implement, implement, implement, innerTypeOf, innerTypeOf, innerTypeOf, invokable, make, make, merge, method, modifiers, modifiers, nestHost, nestMembers, nestMembers, nestMembers, noNestMate, permittedSubclass, permittedSubclass, permittedSubclass, recordComponent, require, require, require, serialVersionUid, typeVariable, typeVariable, typeVariable, typeVariable, withHashCodeEquals, withToString

Methods inherited from class java.lang.Object

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

Constructor Detail

SubclassDynamicTypeBuilder

public SubclassDynamicTypeBuilder(InstrumentedType.WithFlexibleName instrumentedType,
                                  ClassFileVersion classFileVersion,
                                  AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy,
                                  AnnotationValueFilter.Factory annotationValueFilterFactory,
                                  AnnotationRetention annotationRetention,
                                  Implementation.Context.Factory implementationContextFactory,
                                  MethodGraph.Compiler methodGraphCompiler,
                                  TypeValidation typeValidation,
                                  VisibilityBridgeStrategy visibilityBridgeStrategy,
                                  ClassWriterStrategy classWriterStrategy,
                                  LatentMatcher<? super MethodDescription> ignoredMethods,
                                  ConstructorStrategy constructorStrategy)

Creates a new type builder for creating a subclass.

Parameters:

instrumentedType - An instrumented type representing the subclass.

classFileVersion - The class file version to use for types that are not based on an existing class file.

auxiliaryTypeNamingStrategy - The naming strategy to use for naming auxiliary types.

annotationValueFilterFactory - The annotation value filter factory to use.

annotationRetention - The annotation retention strategy to use.

implementationContextFactory - The implementation context factory to use.

methodGraphCompiler - The method graph compiler to use.

typeValidation - Determines if a type should be explicitly validated.

visibilityBridgeStrategy - The visibility bridge strategy to apply.

classWriterStrategy - The class writer strategy to use.

ignoredMethods - A matcher for identifying methods that should be excluded from instrumentation.

constructorStrategy - The constructor strategy to apply onto the instrumented type.

SubclassDynamicTypeBuilder

protected SubclassDynamicTypeBuilder(InstrumentedType.WithFlexibleName instrumentedType,
                                     FieldRegistry fieldRegistry,
                                     MethodRegistry methodRegistry,
                                     RecordComponentRegistry recordComponentRegistry,
                                     TypeAttributeAppender typeAttributeAppender,
                                     AsmVisitorWrapper asmVisitorWrapper,
                                     ClassFileVersion classFileVersion,
                                     AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy,
                                     AnnotationValueFilter.Factory annotationValueFilterFactory,
                                     AnnotationRetention annotationRetention,
                                     Implementation.Context.Factory implementationContextFactory,
                                     MethodGraph.Compiler methodGraphCompiler,
                                     TypeValidation typeValidation,
                                     VisibilityBridgeStrategy visibilityBridgeStrategy,
                                     ClassWriterStrategy classWriterStrategy,
                                     LatentMatcher<? super MethodDescription> ignoredMethods,
                                     List<? extends DynamicType> auxiliaryTypes,
                                     ConstructorStrategy constructorStrategy)

Creates a new type builder for creating a subclass.

Parameters:

instrumentedType - An instrumented type representing the subclass.

fieldRegistry - The field registry to use.

methodRegistry - The method registry to use.

recordComponentRegistry - The record component registry to use.

typeAttributeAppender - The type attribute appender to apply onto the instrumented type.

asmVisitorWrapper - The ASM visitor wrapper to apply onto the class writer.

classFileVersion - The class file version to use for types that are not based on an existing class file.

auxiliaryTypeNamingStrategy - The naming strategy to use for naming auxiliary types.

annotationValueFilterFactory - The annotation value filter factory to use.

annotationRetention - The annotation retention strategy to use.

implementationContextFactory - The implementation context factory to use.

methodGraphCompiler - The method graph compiler to use.

typeValidation - Determines if a type should be explicitly validated.

visibilityBridgeStrategy - The visibility bridge strategy to apply.

classWriterStrategy - The class writer strategy to use.

ignoredMethods - A matcher for identifying methods that should be excluded from instrumentation.

constructorStrategy - The constructor strategy to apply onto the instrumented type.

auxiliaryTypes - A list of explicitly required auxiliary types.

Method Detail

materialize

protected DynamicType.Builder<T> materialize(InstrumentedType.WithFlexibleName instrumentedType,
                                             FieldRegistry fieldRegistry,
                                             MethodRegistry methodRegistry,
                                             RecordComponentRegistry recordComponentRegistry,
                                             TypeAttributeAppender typeAttributeAppender,
                                             AsmVisitorWrapper asmVisitorWrapper,
                                             ClassFileVersion classFileVersion,
                                             AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy,
                                             AnnotationValueFilter.Factory annotationValueFilterFactory,
                                             AnnotationRetention annotationRetention,
                                             Implementation.Context.Factory implementationContextFactory,
                                             MethodGraph.Compiler methodGraphCompiler,
                                             TypeValidation typeValidation,
                                             VisibilityBridgeStrategy visibilityBridgeStrategy,
                                             ClassWriterStrategy classWriterStrategy,
                                             LatentMatcher<? super MethodDescription> ignoredMethods,
                                             List<? extends DynamicType> auxiliaryTypes)

Description copied from class: DynamicType.Builder.AbstractBase.Adapter

Materializes the supplied state of a dynamic type builder.

Specified by:

materialize in class DynamicType.Builder.AbstractBase.Adapter<T>

Parameters:

instrumentedType - The instrumented type.

fieldRegistry - The current field registry.

methodRegistry - The current method registry.

recordComponentRegistry - The record component pool to use.

typeAttributeAppender - The type attribute appender to apply onto the instrumented type.

asmVisitorWrapper - The ASM visitor wrapper to apply onto the class writer.

classFileVersion - The class file version to define auxiliary types in.

auxiliaryTypeNamingStrategy - The naming strategy for auxiliary types to apply.

annotationValueFilterFactory - The annotation value filter factory to apply.

annotationRetention - The annotation retention to apply.

implementationContextFactory - The implementation context factory to apply.

methodGraphCompiler - The method graph compiler to use.

typeValidation - The type validation state.

visibilityBridgeStrategy - The visibility bridge strategy to apply.

classWriterStrategy - The class writer strategy to use.

ignoredMethods - A matcher for identifying methods that should be excluded from instrumentation.

auxiliaryTypes - A list of explicitly required auxiliary types.

Returns:

A type builder that represents the supplied arguments.

make

public DynamicType.Unloaded<T> make(TypeResolutionStrategy typeResolutionStrategy)

Creates the dynamic type this builder represents. If the specified dynamic type is not legal, an IllegalStateException is thrown.

The dynamic type is initialized using a TypeResolutionStrategy.Passive strategy. Using this strategy, no LoadedTypeInitializer is run during the execution of the type's initializer such that no Implementation used for executing the initializer must rely on such an initializer.

Parameters:

typeResolutionStrategy - The type resolution strategy to use for the created type's initialization.

Returns:

An unloaded dynamic type representing the type specified by this builder.

make

public DynamicType.Unloaded<T> make(TypeResolutionStrategy typeResolutionStrategy,
                                    TypePool typePool)

Creates the dynamic type this builder represents. If the specified dynamic type is not legal, an IllegalStateException is thrown.

Parameters:

typeResolutionStrategy - The type resolution strategy to use for the created type's initialization.

typePool - A type pool that is used for computing stack map frames by the underlying class writer, if required.

Returns:

An unloaded dynamic type representing the type specified by this builder.