Interface DynamicType.Builder<T>

Type Parameters:
T - A loaded type that the built type is guaranteed to be a subclass of.
All Known Subinterfaces:
DynamicType.Builder.FieldDefinition.Optional<U>, DynamicType.Builder.FieldDefinition.Optional.Valuable<V>, DynamicType.Builder.InnerTypeDefinition<S>, DynamicType.Builder.InnerTypeDefinition.ForType<U>, DynamicType.Builder.MethodDefinition<S>, DynamicType.Builder.MethodDefinition.ImplementationDefinition.Optional<V>, DynamicType.Builder.MethodDefinition.ReceiverTypeDefinition<U>, DynamicType.Builder.RecordComponentDefinition.Optional<U>, DynamicType.Builder.TypeVariableDefinition<S>
All Known Implementing Classes:
AbstractInliningDynamicTypeBuilder, DecoratingDynamicTypeBuilder, DynamicType.Builder.AbstractBase, 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.AnnotationAdapter, DynamicType.Builder.AbstractBase.Adapter.MethodMatchAdapter.AnnotationAdapter, DynamicType.Builder.AbstractBase.Adapter.OptionalMethodMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.RecordComponentDefinitionAdapter, DynamicType.Builder.AbstractBase.Adapter.RecordComponentMatchAdapter, DynamicType.Builder.AbstractBase.Adapter.TypeVariableDefinitionAdapter, DynamicType.Builder.AbstractBase.Delegator, DynamicType.Builder.FieldDefinition.Optional.AbstractBase, DynamicType.Builder.FieldDefinition.Optional.Valuable.AbstractBase, DynamicType.Builder.FieldDefinition.Optional.Valuable.AbstractBase.Adapter, DynamicType.Builder.MethodDefinition.AbstractBase, DynamicType.Builder.MethodDefinition.AbstractBase.Adapter, DynamicType.Builder.MethodDefinition.ReceiverTypeDefinition.AbstractBase, DynamicType.Builder.RecordComponentDefinition.Optional.AbstractBase, DynamicType.Builder.TypeVariableDefinition.AbstractBase, RebaseDynamicTypeBuilder, RedefinitionDynamicTypeBuilder, SubclassDynamicTypeBuilder
Enclosing interface:
DynamicType

public static interface DynamicType.Builder<T>
A builder for creating a dynamic type.
  • Method Details

    • visit

      DynamicType.Builder<T> visit(AsmVisitorWrapper asmVisitorWrapper)
      Applies the supplied AsmVisitorWrapper onto the ClassVisitor during building a dynamic type. Using an ASM visitor, it is possible to manipulate byte code directly. Byte Buddy does not validate directly created byte code and it remains the responsibility of the visitor's implementor to generate legal byte code. If several ASM visitor wrappers are registered, they are applied on top of another in their registration order.
      Parameters:
      asmVisitorWrapper - The ASM visitor wrapper to apply during
      Returns:
      A new builder that is equal to this builder and applies the ASM visitor wrapper.
    • name

      Names the dynamic type by the supplied name. The name needs to be fully qualified and in the binary format (packages separated by dots: foo.Bar). A type's package determines what other types are visible to the instrumented type and what methods can be overridden or be represented in method signatures or as field types.
      Parameters:
      name - The fully qualified name of the generated class in a binary format.
      Returns:
      A new builder that is equal to this builder but with the instrumented type named by the supplied name.
    • suffix

      DynamicType.Builder<T> suffix(String suffix)
      Adds a suffix to the current type name without changing the type's package.
      Parameters:
      suffix - The suffix to append to the current type name.
      Returns:
      A new builder that is equal to this builder but with the instrumented type named suffixed by the supplied suffix.
    • modifiers

      DynamicType.Builder<T> modifiers(ModifierContributor.ForType... modifierContributor)
      Defines the supplied modifiers as the modifiers of the instrumented type.
      Parameters:
      modifierContributor - The modifiers of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied modifiers applied onto the instrumented type.
    • modifiers

      DynamicType.Builder<T> modifiers(Collection<? extends ModifierContributor.ForType> modifierContributors)
      Defines the supplied modifiers as the modifiers of the instrumented type.
      Parameters:
      modifierContributors - The modifiers of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied modifiers applied onto the instrumented type.
    • modifiers

      DynamicType.Builder<T> modifiers(int modifiers)
      Defines the supplied modifiers as the modifiers of the instrumented type.
      Parameters:
      modifiers - The modifiers of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied modifiers applied onto the instrumented type.
    • merge

      DynamicType.Builder<T> merge(ModifierContributor.ForType... modifierContributor)
      Merges the supplied modifier contributors with the modifiers of the instrumented type and defines them as the instrumented type's new modifiers.
      Parameters:
      modifierContributor - The modifiers of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied modifiers merged into the instrumented type's modifiers.
    • merge

      DynamicType.Builder<T> merge(Collection<? extends ModifierContributor.ForType> modifierContributors)
      Merges the supplied modifier contributors with the modifiers of the instrumented type and defines them as the instrumented type's new modifiers.
      Parameters:
      modifierContributors - The modifiers of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied modifiers merged into the instrumented type's modifiers.
    • topLevelType

      DynamicType.Builder<T> topLevelType()

      Defines this type as a top-level type that is not declared by another type or enclosed by another member.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Returns:
      A new builder that is equal to this builder but without any declaration of a a declared or enclosed type.
    • innerTypeOf

      Defines this type as an inner type of the supplied type. Without any additional configuration, the type declaration is defined as a local type.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The type to declare as the built type's outer type.
      Returns:
      A new builder that is equal to this builder with the supplied type as the built type's outer type.
    • innerTypeOf

      Defines this type as an inner type of the supplied type. Without any additional configuration, the type declaration is defined as a local type.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The type to declare as the built type's outer type.
      Returns:
      A new builder that is equal to this builder with the supplied type as the built type's outer type.
    • innerTypeOf

      Defines this type as an inner type that was declared within the supplied method. Without any additional configuration, the type declaration is defined as a local type.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      method - The method to declare as the built type's declaring method.
      Returns:
      A new builder that is equal to this builder with the supplied method as the built type's declaring method.
    • innerTypeOf

      Defines this type as an inner type that was declared within the supplied constructor. Without any additional configuration, the type declaration is defined as a local type.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      constructor - The constructor to declare as the built type's declaring method.
      Returns:
      A new builder that is equal to this builder with the supplied method as the built type's declaring constructor.
    • innerTypeOf

      Defines this type as an inner type that was declared within the supplied method or constructor. Without any additional configuration, the type declaration is defined as a local type.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      methodDescription - The method or constructor to declare as the built type's declaring method.
      Returns:
      A new builder that is equal to this builder with the supplied method as the built type's declaring method or constructor.
    • declaredTypes

      DynamicType.Builder<T> declaredTypes(Class<?>... type)

      Defines this type as an the outer type of the supplied types. Using this method, it is possible to add inner type declarations for anonymous or local types which are not normally exposed by type descriptions. Doing so, it is however possible to indicate to Byte Buddy that the required attributes for such an inner type declaration should be added to a class file.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The types being declared.
      Returns:
      A new builder that is equal to this builder with the supplied types being declared by the built type.
    • declaredTypes

      DynamicType.Builder<T> declaredTypes(TypeDescription... type)

      Defines this type as an the outer type of the supplied types. Using this method, it is possible to add inner type declarations for anonymous or local types which are not normally exposed by type descriptions. Doing so, it is however possible to indicate to Byte Buddy that the required attributes for such an inner type declaration should be added to a class file.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The types being declared.
      Returns:
      A new builder that is equal to this builder with the supplied types being declared by the built type.
    • declaredTypes

      DynamicType.Builder<T> declaredTypes(List<? extends Class<?>> types)

      Defines this type as an the outer type of the supplied types. Using this method, it is possible to add inner type declarations for anonymous or local types which are not normally exposed by type descriptions. Doing so, it is however possible to indicate to Byte Buddy that the required attributes for such an inner type declaration should be added to a class file.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      types - The types being declared.
      Returns:
      A new builder that is equal to this builder with the supplied types being declared by the built type.
    • declaredTypes

      DynamicType.Builder<T> declaredTypes(Collection<? extends TypeDescription> types)

      Defines this type as an the outer type of the supplied types. Using this method, it is possible to add inner type declarations for anonymous or local types which are not normally exposed by type descriptions. Doing so, it is however possible to indicate to Byte Buddy that the required attributes for such an inner type declaration should be added to a class file.

      Important: Changing the declaration hierarchy of a type has no influence on the nest mate hierarchy.

      Warning: By changing this type's declaration, any other type will not change its declaration of enclosing members or declared types about any nesting of a declaration. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      types - The types being declared.
      Returns:
      A new builder that is equal to this builder with the supplied types being declared by the built type.
    • noNestMate

      DynamicType.Builder<T> noNestMate()

      Defines this type as self-hosted, i.e. as only being a nest mate of itself.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Returns:
      A new builder that is equal to this builder but where the built type is a self-hosted nest mate.
    • nestHost

      DynamicType.Builder<T> nestHost(Class<?> type)

      Defines this type as a nest member of the supplied type as a nest host.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The nest host.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest member of the supplied host.
    • nestHost

      Defines this type as a nest member of the supplied type as a nest host.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The nest host.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest member of the supplied host.
    • nestMembers

      DynamicType.Builder<T> nestMembers(Class<?>... type)

      Defines this type as a nest host for the supplied types.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The nest members.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest host of the supplied types.
    • nestMembers

      DynamicType.Builder<T> nestMembers(TypeDescription... type)

      Defines this type as a nest host for the supplied types.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      type - The nest members.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest host of the supplied types.
    • nestMembers

      DynamicType.Builder<T> nestMembers(List<? extends Class<?>> types)

      Defines this type as a nest host for the supplied types.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      types - The nest members.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest host of the supplied types.
    • nestMembers

      DynamicType.Builder<T> nestMembers(Collection<? extends TypeDescription> types)

      Defines this type as a nest host for the supplied types.

      Important: Changing the nest mate hierarchy of a type has no influence on the declaration hierarchy.

      Warning: Changing nest mate hierarchies always requires changing a member and its host or a host and all its members. Otherwise, the runtime will not accept further nest mates. It is the responsibility of the user of this API to keep such declarations consistent among the definitions of connected types.

      Parameters:
      types - The nest members.
      Returns:
      A new builder that is equal to this builder but where the built type is a nest host of the supplied types.
    • permittedSubclass

      DynamicType.Builder<T> permittedSubclass(Class<?>... type)
      Defines this type to allow the supplied permitted subclasses additionally to any prior permitted subclasses. If this type was not previously sealed, only the supplied subclasses are permitted.
      Parameters:
      type - The permitted subclasses.
      Returns:
      A new builder that is equal to this builder but where the built type permits the supplied subclasses.
    • permittedSubclass

      DynamicType.Builder<T> permittedSubclass(TypeDescription... type)
      Defines this type to allow the supplied permitted subclasses additionally to any prior permitted subclasses. If this type was not previously sealed, only the supplied subclasses are permitted.
      Parameters:
      type - The permitted subclasses.
      Returns:
      A new builder that is equal to this builder but where the built type permits the supplied subclasses.
    • permittedSubclass

      DynamicType.Builder<T> permittedSubclass(List<? extends Class<?>> types)
      Defines this type to allow the supplied permitted subclasses additionally to any prior permitted subclasses. If this type was not previously sealed, only the supplied subclasses are permitted.
      Parameters:
      types - The permitted subclasses.
      Returns:
      A new builder that is equal to this builder but where the built type permits the supplied subclasses.
    • permittedSubclass

      DynamicType.Builder<T> permittedSubclass(Collection<? extends TypeDescription> types)
      Defines this type to allow the supplied permitted subclasses additionally to any prior permitted subclasses. If this type was not previously sealed, only the supplied subclasses are permitted.
      Parameters:
      types - The permitted subclasses.
      Returns:
      A new builder that is equal to this builder but where the built type permits the supplied subclasses.
    • unsealed

      DynamicType.Builder<T> unsealed()
      Unseales this type.
      Returns:
      A new builder that is equal to this builder but where the built type does not restrain its permitted subclasses.
    • attribute

      DynamicType.Builder<T> attribute(TypeAttributeAppender typeAttributeAppender)
      Applies the given type attribute appender onto the instrumented type. Using a type attribute appender, it is possible to append any type of meta data to a type, not only Java Annotations.
      Parameters:
      typeAttributeAppender - The type attribute appender to apply.
      Returns:
      A new builder that is equal to this builder but with the supplied type attribute appender applied to the instrumented type.
    • annotateType

      DynamicType.Builder<T> annotateType(Annotation... annotation)
      Annotates the instrumented type with the supplied annotations.
      Parameters:
      annotation - The annotations to add to the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the annotations added to the instrumented type.
    • annotateType

      DynamicType.Builder<T> annotateType(List<? extends Annotation> annotations)
      Annotates the instrumented type with the supplied annotations.
      Parameters:
      annotations - The annotations to add to the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the annotations added to the instrumented type.
    • annotateType

      DynamicType.Builder<T> annotateType(AnnotationDescription... annotation)
      Annotates the instrumented type with the supplied annotations.
      Parameters:
      annotation - The annotations to add to the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the annotations added to the instrumented type.
    • annotateType

      DynamicType.Builder<T> annotateType(Collection<? extends AnnotationDescription> annotations)
      Annotates the instrumented type with the supplied annotations.
      Parameters:
      annotations - The annotations to add to the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the annotations added to the instrumented type.
    • implement

      Implements the supplied interfaces for the instrumented type. Optionally, it is possible to define the methods that are defined by the interfaces or the interfaces' super interfaces. This excludes methods that are explicitly ignored.

      Note: This methods implements the supplied types as is, i.e. any Class values are implemented as raw types if they declare type variables or an owner type.

      Parameters:
      interfaceType - The interface types to implement.
      Returns:
      A new builder that is equal to this builder but with the interfaces implemented by the instrumented type.
    • implement

      Implements the supplied interfaces for the instrumented type. Optionally, it is possible to define the methods that are defined by the interfaces or the interfaces' super interfaces. This excludes methods that are explicitly ignored.

      Note: This methods implements the supplied types as is, i.e. any Class values are implemented as raw types if they declare type variables or an owner type.

      Parameters:
      interfaceTypes - The interface types to implement.
      Returns:
      A new builder that is equal to this builder but with the interfaces implemented by the instrumented type.
    • implement

      Implements the supplied interfaces for the instrumented type. Optionally, it is possible to define the methods that are defined by the interfaces or the interfaces' super interfaces. This excludes methods that are explicitly ignored.

      Note: This methods implements the supplied types as is, i.e. any TypeDescription values are implemented as raw types if they declare type variables or an owner type.

      Parameters:
      interfaceType - The interface types to implement.
      Returns:
      A new builder that is equal to this builder but with the interfaces implemented by the instrumented type.
    • implement

      Implements the supplied interfaces for the instrumented type. Optionally, it is possible to define the methods that are defined by the interfaces or the interfaces' super interfaces. This excludes methods that are explicitly ignored.

      Note: This methods implements the supplied types as is, i.e. any TypeDescription values are implemented as raw types if they declare type variables or an owner type.

      Parameters:
      interfaceTypes - The interface types to implement.
      Returns:
      A new builder that is equal to this builder but with the interfaces implemented by the instrumented type.
    • initializer

      DynamicType.Builder<T> initializer(ByteCodeAppender byteCodeAppender)

      Executes the supplied byte code appender within the beginning of the instrumented type's type initializer. The supplied byte code appender must not return from the method. If several byte code appenders are supplied, they are executed within their application order.

      This method should only be used for preparing an instrumented type with a specific configuration. Normally, a byte code appender is applied via Byte Buddy's standard API by invoking invokable(ElementMatcher) using the ElementMatchers.isTypeInitializer() matcher.

      Parameters:
      byteCodeAppender - The byte code appender to execute within the instrumented type's type initializer.
      Returns:
      A new builder that is equal to this builder but with the supplied byte code appender being executed within the instrumented type's type initializer.
    • initializer

      DynamicType.Builder<T> initializer(LoadedTypeInitializer loadedTypeInitializer)
      Executes the supplied loaded type initializer when loading the created instrumented type. If several loaded type initializers are supplied, each loaded type initializer is executed in its registration order.
      Parameters:
      loadedTypeInitializer - The loaded type initializer to execute upon loading the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the supplied loaded type initializer executed upon loading the instrumented type.
    • require

      DynamicType.Builder<T> require(TypeDescription type, byte[] binaryRepresentation)
      Explicitly requires another dynamic type for the creation of this type.
      Parameters:
      type - The type to require.
      binaryRepresentation - The type's binary representation.
      Returns:
      A new builder that is equal to this builder but which explicitly requires the supplied type.
    • require

      DynamicType.Builder<T> require(TypeDescription type, byte[] binaryRepresentation, LoadedTypeInitializer typeInitializer)
      Explicitly requires another dynamic type for the creation of this type.
      Parameters:
      type - The type to require.
      binaryRepresentation - The type's binary representation.
      typeInitializer - The type's loaded type initializer.
      Returns:
      A new builder that is equal to this builder but which explicitly requires the supplied type.
    • require

      DynamicType.Builder<T> require(DynamicType... auxiliaryType)
      Explicitly requires other dynamic types for the creation of this type.
      Parameters:
      auxiliaryType - The required dynamic types.
      Returns:
      A new builder that is equal to this builder but which explicitly requires the supplied types.
    • require

      DynamicType.Builder<T> require(Collection<DynamicType> auxiliaryTypes)
      Explicitly requires other dynamic types for the creation of this type.
      Parameters:
      auxiliaryTypes - The required dynamic types.
      Returns:
      A new builder that is equal to this builder but which explicitly requires the supplied types.
    • typeVariable

      Defines the supplied type variable without any bounds as a type variable of the instrumented type.
      Parameters:
      symbol - The type variable's symbol.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type.
    • typeVariable

      DynamicType.Builder.TypeVariableDefinition<T> typeVariable(String symbol, Type... bound)
      Defines the supplied type variable with the given bound as a type variable of the instrumented type.
      Parameters:
      symbol - The type variable's symbol.
      bound - The type variable's upper bounds. Can also be TargetType if the bound type should be equal to the currently instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type.
    • typeVariable

      DynamicType.Builder.TypeVariableDefinition<T> typeVariable(String symbol, List<? extends Type> bounds)
      Defines the supplied type variable with the given bound as a type variable of the instrumented type.
      Parameters:
      symbol - The type variable's symbol.
      bounds - The type variable's upper bounds. Can also be TargetType if the bound type should be equal to the currently instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type.
    • typeVariable

      Defines the supplied type variable with the given bound as a type variable of the instrumented type.
      Parameters:
      symbol - The type variable's symbol.
      bound - The type variable's upper bounds. Can also be TargetType if the bound type should be equal to the currently instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type.
    • typeVariable

      Defines the supplied type variable with the given bound as a type variable of the instrumented type.
      Parameters:
      symbol - The type variable's symbol.
      bounds - The type variable's upper bounds. Can also be TargetType if the bound type should be equal to the currently instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type.
    • transform

      Transforms any type variable that is defined by this type if it is matched by the supplied matcher.
      Parameters:
      matcher - The matcher to decide what type variables to transform.
      transformer - The transformer to apply to the matched type variables.
      Returns:
      A new builder that is equal to this builder but with the supplied transformer applied to all type variables.
    • defineField

      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifierContributor - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • defineField

      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifierContributors - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • defineField

      DynamicType.Builder.FieldDefinition.Optional.Valuable<T> defineField(String name, Type type, int modifiers)
      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifiers - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • defineField

      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifierContributor - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • defineField

      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifierContributors - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • defineField

      Defines the specified field as a field of the built dynamic type.
      Parameters:
      name - The name of the field.
      type - The type of the field. Can also be TargetType if the field type should be equal to the currently instrumented type.
      modifiers - The modifiers of the field.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • define

      Defines a field that is similar to the supplied field but without copying any annotations on the field.
      Parameters:
      field - The field to imitate as a field of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • define

      Defines a field that is similar to the supplied field but without copying any annotations on the field.
      Parameters:
      field - The field to imitate as a field of the instrumented type.
      Returns:
      A new builder that is equal to this builder but with the given field defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • serialVersionUid

      DynamicType.Builder.FieldDefinition.Optional<T> serialVersionUid(long serialVersionUid)
      Defines a private, static, final field for a serial version UID of the given value.
      Parameters:
      serialVersionUid - The serial version UID to define as a value.
      Returns:
      A new builder that is equal to this builder but with the given type variable defined for the instrumented type. Furthermore, it is possible to optionally define a value, annotations or custom attributes for the field.
    • field

      Matches a field that is already declared by the instrumented type. This gives opportunity to change that field's default value, annotations or custom attributes.

      When a type is redefined or rebased, any annotations that the field declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a field is already matched by a previously specified field matcher, the new field definition gets precedence over the previous definition, i.e. the previous field definition is no longer applied.

      Parameters:
      matcher - The matcher that determines what declared fields are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a field's definition.
    • field

      Matches a field that is already declared by the instrumented type. This gives opportunity to change that field's default value, annotations or custom attributes. Using a latent matcher gives opportunity to resolve an ElementMatcher based on the instrumented type before applying the matcher.

      When a type is redefined or rebased, any annotations that the field declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a field is already matched by a previously specified field matcher, the new field definition gets precedence over the previous definition, i.e. the previous field definition is no longer applied.

      Parameters:
      matcher - The matcher that determines what declared fields are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a field's definition.
    • ignoreAlso

      DynamicType.Builder<T> ignoreAlso(ElementMatcher<? super MethodDescription> ignoredMethods)

      Specifies to exclude any method that is matched by the supplied matcher from instrumentation. Previously supplied matchers remain valid after supplying a new matcher, i.e. any method that is matched by a previously supplied matcher is always ignored.

      When ignoring a type, previously registered matchers are applied before this matcher. If a previous matcher indicates that a type is to be ignored, this matcher is no longer executed.

      Parameters:
      ignoredMethods - The matcher for determining what methods to exclude from instrumentation.
      Returns:
      A new builder that is equal to this builder but that is excluding any method that is matched by the supplied matcher from instrumentation.
    • ignoreAlso

      DynamicType.Builder<T> ignoreAlso(LatentMatcher<? super MethodDescription> ignoredMethods)

      Specifies to exclude any method that is matched by the supplied matcher from instrumentation. Previously supplied matchers remain valid after supplying a new matcher, i.e. any method that is matched by a previously supplied matcher is always ignored. Using a latent matcher gives opportunity to resolve an ElementMatcher based on the instrumented type before applying the matcher.

      When ignoring a type, previously registered matchers are applied before this matcher. If a previous matcher indicates that a type is to be ignored, this matcher is no longer executed.

      Parameters:
      ignoredMethods - The matcher for determining what methods to exclude from instrumentation.
      Returns:
      A new builder that is equal to this builder but that is excluding any method that is matched by the supplied matcher from instrumentation.
    • defineMethod

      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifierContributor - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineMethod

      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifierContributors - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineMethod

      DynamicType.Builder.MethodDefinition.ParameterDefinition.Initial<T> defineMethod(String name, Type returnType, int modifiers)
      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifiers - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineMethod

      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifierContributor - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineMethod

      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifierContributors - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineMethod

      Defines the specified method to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      name - The name of the method.
      returnType - The method's return type. Can also be TargetType if the return type should be equal to the currently instrumented type.
      modifiers - The method's modifiers.
      Returns:
      A builder that allows for further defining the method, either by adding more properties or by defining an implementation.
    • defineConstructor

      Defines the specified constructor to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      modifierContributor - The constructor's modifiers.
      Returns:
      A builder that allows for further defining the constructor, either by adding more properties or by defining an implementation.
    • defineConstructor

      Defines the specified constructor to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      modifierContributors - The constructor's modifiers.
      Returns:
      A builder that allows for further defining the constructor, either by adding more properties or by defining an implementation.
    • defineConstructor

      Defines the specified constructor to be declared by the instrumented type. Method parameters or parameter types, declared exceptions and type variables can be defined in subsequent steps.
      Parameters:
      modifiers - The constructor's modifiers.
      Returns:
      A builder that allows for further defining the constructor, either by adding more properties or by defining an implementation.
    • define

      Defines a method that is similar to the supplied method but without copying any annotations of the method or method parameters.
      Parameters:
      method - The method to imitate as a method of the instrumented type.
      Returns:
      A builder that allows for defining an implementation for the method.
    • define

      Defines a constructor that is similar to the supplied constructor but without copying any annotations of the constructor or constructor parameters.
      Parameters:
      constructor - The constructor to imitate as a method of the instrumented type.
      Returns:
      A builder that allows for defining an implementation for the constructor.
    • define

      Defines a method or constructor that is similar to the supplied method description but without copying any annotations of the method/constructor or method/constructor parameters.
      Parameters:
      methodDescription - The method description to imitate as a method or constructor of the instrumented type.
      Returns:
      A builder that allows for defining an implementation for the method or constructor.
    • defineProperty

      Defines a Java bean property with the specified name.
      Parameters:
      name - The name of the property.
      type - The property type.
      Returns:
      A builder that defines the specified property where the field holding the property can be refined by subsequent steps.
    • defineProperty

      DynamicType.Builder.FieldDefinition.Optional<T> defineProperty(String name, Type type, boolean readOnly)
      Defines a Java bean property with the specified name.
      Parameters:
      name - The name of the property.
      type - The property type.
      readOnly - true if the property is read only, i.e. no setter should be defined and the field should be final.
      Returns:
      A builder that defines the specified property where the field holding the property can be refined by subsequent steps.
    • defineProperty

      Defines a Java bean property with the specified name.
      Parameters:
      name - The name of the property.
      type - The property type.
      Returns:
      A builder that defines the specified property where the field holding the property can be refined by subsequent steps.
    • defineProperty

      DynamicType.Builder.FieldDefinition.Optional<T> defineProperty(String name, TypeDefinition type, boolean readOnly)
      Defines a Java bean property with the specified name.
      Parameters:
      name - The name of the property.
      type - The property type.
      readOnly - true if the property is read only, i.e. no setter should be defined and the field should be final.
      Returns:
      A builder that defines the specified property where the field holding the property can be refined by subsequent steps.
    • method

      Matches a method that is already declared or inherited by the instrumented type. This gives opportunity to change or to override that method's implementation, default value, annotations or custom attributes. It is also possible to make a method abstract.

      When a type is redefined or rebased, any annotations that the method declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a method is already matched by a previously specified matcher, the new method definition gets precedence over the previous definition, i.e. the previous method definition is no longer applied.

      Note that the specified definition does never apply for methods that are explicitly ignored.

      Parameters:
      matcher - The matcher that determines what methods are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a method's or constructor's definition.
    • constructor

      Matches a constructor that is already declared by the instrumented type. This gives opportunity to change that constructor's implementation, default value, annotations or custom attributes.

      When a type is redefined or rebased, any annotations that the constructor declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a constructor is already matched by a previously specified matcher, the new constructor definition gets precedence over the previous definition, i.e. the previous constructor definition is no longer applied.

      Note that the specified definition does never apply for methods that are explicitly ignored.

      Parameters:
      matcher - The matcher that determines what constructors are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a method's or constructor's definition.
    • invokable

      Matches a method or constructor that is already declared or inherited by the instrumented type. This gives opportunity to change or to override that method's or constructor's implementation, default value, annotations or custom attributes. It is also possible to make a method abstract.

      When a type is redefined or rebased, any annotations that the method or constructor declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a method or constructor is already matched by a previously specified matcher, the new definition gets precedence over the previous definition, i.e. the previous definition is no longer applied.

      Note that the specified definition does never apply for methods that are explicitly ignored.

      Important: It is possible to instrument the dynamic type's initializer. Depending on the used TypeResolutionStrategy, the type initializer might be run before Byte Buddy could apply any LoadedTypeInitializers which are responsible for preparing the instrumented type prior to the initializer's execution. For preparing the type prior to executing the initializer, an TypeResolutionStrategy.Active resolver must be chosen.

      Parameters:
      matcher - The matcher that determines what methods or constructors are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a method's or constructor's definition.
    • invokable

      Matches a method or constructor that is already declared or inherited by the instrumented type. This gives opportunity to change or to override that method's or constructor's implementation, default value, annotations or custom attributes. It is also possible to make a method abstract. Using a latent matcher gives opportunity to resolve an ElementMatcher based on the instrumented type before applying the matcher.

      When a type is redefined or rebased, any annotations that the method or constructor declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a method or constructor is already matched by a previously specified matcher, the new definition gets precedence over the previous definition, i.e. the previous definition is no longer applied.

      Note that the specified definition does never apply for methods that are explicitly ignored.

      Important: It is possible to instrument the dynamic type's initializer. Depending on the used TypeResolutionStrategy, the type initializer might be run before Byte Buddy could apply any LoadedTypeInitializers which are responsible for preparing the instrumented type prior to the initializer's execution. For preparing the type prior to executing the initializer, an TypeResolutionStrategy.Active resolver must be chosen.

      Parameters:
      matcher - The matcher that determines what declared methods or constructors are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a method's or constructor's definition.
    • withHashCodeEquals

      DynamicType.Builder<T> withHashCodeEquals()
      Implements Object.hashCode() and Object.equals(Object) methods for the instrumented type if those methods are not declared as final by a super class. The implementations do not consider any implementations of a super class and compare a class field by field without considering synthetic fields.
      Returns:
      A new type builder that defines Object.hashCode() and Object.equals(Object) methods accordingly.
    • withToString

      DynamicType.Builder<T> withToString()
      Implements a Object.toString() method for the instrumented type if such a method is not declared as final by a super class. The implementation prefixes the string with the simple class name and prints each non-synthetic field's value after the field's name.
      Returns:
      A new type builder that defines Object.toString() method accordingly.
    • defineRecordComponent

      Defines a new record component. Note that this does not add or change implementations for a field, an accessor to this field or a constructor unless ByteBuddy.makeRecord() is used.
      Parameters:
      name - The record component's name.
      type - The record component's type.
      Returns:
      A new builder that is equal to this builder but also defines the supplied record component.
    • defineRecordComponent

      Defines a new record component. Note that this does not add or change implementations for a field, an accessor to this field or a constructor unless ByteBuddy.makeRecord() is used.
      Parameters:
      name - The record component's name.
      type - The record component's type.
      Returns:
      A new builder that is equal to this builder but also defines the supplied record component.
    • define

      Defines a new record component. Note that this does not add or change implementations for a field, an accessor to this field or a constructor unless ByteBuddy.makeRecord() is used.
      Parameters:
      recordComponentDescription - A description of the record component to immitate.
      Returns:
      A new builder that is equal to this builder but also defines the supplied record component.
    • recordComponent

      Matches a record component that is already declared by the instrumented type. This gives opportunity to change that record component's annotations or custom attributes.

      When a type is redefined or rebased, any annotations that the field declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a record component is already matched by a previously specified record component matcher, the new record component definition gets precedence over the previous definition, i.e. the previous record component definition is no longer applied.

      Parameters:
      matcher - The matcher that determines what declared record components are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a record component's definition.
    • recordComponent

      Matches a record component that is already declared by the instrumented type. This gives opportunity to change that record component's annotations or custom attributes.

      When a type is redefined or rebased, any annotations that the field declared previously is preserved as it is if Byte Buddy is configured to retain such annotations by AnnotationRetention.ENABLED. If any existing annotations should be altered, annotation retention must be disabled.

      If a record component is already matched by a previously specified record component matcher, the new record component definition gets precedence over the previous definition, i.e. the previous record component definition is no longer applied.

      Parameters:
      matcher - The matcher that determines what declared record components are affected by the subsequent specification.
      Returns:
      A builder that allows for changing a record component's definition.
    • make

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

      Other than make(TypePool), this method supplies a context-dependant type pool to the underlying class writer. Supplying a type pool only makes sense if custom byte code is created by adding a custom AsmVisitorWrapper where ASM might be required to compute stack map frames by processing information over any mentioned type's class hierarchy.

      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.

      Returns:
      An unloaded dynamic type representing the type specified by this builder.
    • make

      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

      DynamicType.Unloaded<T> make(TypePool typePool)

      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:
      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.
    • make

      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.
    • toTypeDescription

      TypeDescription toTypeDescription()
      Returns a TypeDescription for the currently built type.
      Returns:
      A TypeDescription for the currently built type.