net.bytebuddy

Class ByteBuddy.MethodAnnotationTarget

java.lang.Object

net.bytebuddy.ByteBuddy

net.bytebuddy.ByteBuddy.MethodAnnotationTarget

Enclosing class:

ByteBuddy

public static class ByteBuddy.MethodAnnotationTarget
extends ByteBuddy

A ByteBuddy configuration with a selected set of methods for which annotations can be defined.

Nested Class Summary

Nested classes/interfaces inherited from class net.bytebuddy.ByteBuddy

ByteBuddy.Definable<T>, ByteBuddy.MatchedMethodInterception, ByteBuddy.MethodAnnotationTarget, ByteBuddy.MethodInterceptable, ByteBuddy.OptionalMethodInterception

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodAttributeAppender.Factory	attributeAppenderFactory The method attribute appender factory that was defined for the current method selection.
protected Instrumentation	instrumentation The instrumentation that was defined for the current method selection.
protected MethodMatcher	methodMatcher The method matcher representing the current method selection.

Fields inherited from class net.bytebuddy.ByteBuddy

bridgeMethodResolverFactory, classFileVersion, classVisitorWrapperChain, defaultFieldAttributeAppenderFactory, defaultMethodAttributeAppenderFactory, ignoredMethods, interfaceTypes, methodRegistry, modifiers, namingStrategy, typeAttributeAppender

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

MethodAnnotationTarget(ClassFileVersion classFileVersion, NamingStrategy namingStrategy, List<TypeDescription> interfaceTypes, MethodMatcher ignoredMethods, BridgeMethodResolver.Factory bridgeMethodResolverFactory, ClassVisitorWrapper.Chain classVisitorWrapperChain, MethodRegistry methodRegistry, ByteBuddy.Definable<Integer> modifiers, ByteBuddy.Definable<TypeAttributeAppender> typeAttributeAppender, FieldAttributeAppender.Factory defaultFieldAttributeAppenderFactory, MethodAttributeAppender.Factory defaultMethodAttributeAppenderFactory, MethodMatcher methodMatcher, Instrumentation instrumentation, MethodAttributeAppender.Factory attributeAppenderFactory) Creates a new method annotation target.

Method Summary

Modifier and Type	Method and Description
ByteBuddy.MethodAnnotationTarget	annotateMethod(Annotation... annotation) Defines an method annotation for the currently selected methods.
ByteBuddy.MethodAnnotationTarget	annotateParameter(int parameterIndex, Annotation... annotation) Defines an method annotation for a parameter of the currently selected methods.
ByteBuddy.MethodAnnotationTarget	attribute(MethodAttributeAppender.Factory attributeAppenderFactory) Defines a given attribute appender factory to be applied for the currently selected methods.
boolean	equals(Object other)
ClassFileVersion	getClassFileVersion() Returns the class format version that is defined for the current configuration.
ClassVisitorWrapper.Chain	getClassVisitorWrapperChain() Returns the class visitor wrapper chain for the current configuration.
FieldAttributeAppender.Factory	getDefaultFieldAttributeAppenderFactory() Returns the default field attribute appender factory which is applied to any field that is defined for instrumentations that are applied by this configuration.
MethodAttributeAppender.Factory	getDefaultMethodAttributeAppenderFactory() Returns the default method attribute appender factory which is applied to any method that is defined or intercepted for instrumentations that are applied by this configuration.
MethodMatcher	getIgnoredMethods() Returns the matcher for the ignored methods for the current configuration.
List<TypeDescription>	getInterfaceTypes() Returns the naming strategy for the current configuration.
NamingStrategy	getNamingStrategy() Returns the naming strategy for the current configuration.
int	hashCode()
ByteBuddy.MatchedMethodInterception	invokable(MethodMatcher methodMatcher) Intercepts a given selection of byte code methods that can be a method or a constructor.
protected ByteBuddy	materialize() Materializes this configuration as new ByteBuddy instance.
<T> DynamicType.Builder<T>	subclass(Class<T> superType) Creates a dynamic type builder that creates a subclass of a given loaded type where the subclass is created by the ConstructorStrategy.Default.IMITATE_SUPER_TYPE strategy.
<T> DynamicType.Builder<T>	subclass(Class<T> superType, ConstructorStrategy constructorStrategy) Creates a dynamic type builder that creates a subclass of a given loaded type.
<T> DynamicType.Builder<T>	subclass(TypeDescription superType) Creates a dynamic type builder that creates a subclass of a given type description where the subclass is created by the ConstructorStrategy.Default.IMITATE_SUPER_TYPE strategy.
<T> DynamicType.Builder<T>	subclass(TypeDescription superType, ConstructorStrategy constructorStrategy) Creates a dynamic type builder that creates a subclass of a given type description.
String	toString()
ByteBuddy	withAttribute(TypeAttributeAppender typeAttributeAppender) Defines a new type attribute appender for this configuration that replaces the currently defined type attribute appender.
ByteBuddy	withClassFormatVersion(ClassFileVersion classFileVersion) Defines a new class format version for this configuration.
ByteBuddy	withClassVisitor(ClassVisitorWrapper classVisitorWrapper) Defines a new class visitor to be appended to the current collection of ClassVisitors that are to be applied onto any creation process of a dynamic type.
ByteBuddy	withDefaultFieldAttributeAppender(FieldAttributeAppender.Factory attributeAppenderFactory) Defines a new default field attribute appender factory that is applied onto any field.
ByteBuddy	withDefaultMethodAttributeAppender(MethodAttributeAppender.Factory attributeAppenderFactory) Defines a new default method attribute appender factory that is applied onto any method.
ByteBuddy	withIgnoredMethods(MethodMatcher ignoredMethods) Defines a new method matcher for methods that are ignored by any dynamic type that is created by this configuration which will replace the current configuration.
ByteBuddy.OptionalMethodInterception	withImplementing(Class<?> type) Defines all dynamic types that are created by this configuration to implement the given interface.
ByteBuddy.OptionalMethodInterception	withImplementing(TypeDescription type) Defines all dynamic types that are created by this configuration to implement the given interface.
ByteBuddy	withModifiers(ModifierContributor.ForType... modifierContributor) Defines a new modifier contributors for this configuration that replaces the currently defined modifier contributes which might currently be implicit.
ByteBuddy	withNamingStrategy(NamingStrategy namingStrategy) Defines a new naming strategy for this configuration.
ByteBuddy	withTypeAnnotation(Annotation... annotation) Defines a new type annotation for this configuration that replaces the currently defined type attribute appender.

Methods inherited from class net.bytebuddy.ByteBuddy

constructor, getBridgeMethodResolverFactory, getMethodRegistry, getModifiers, getTypeAttributeAppender, method

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

methodMatcher

protected final MethodMatcher methodMatcher

The method matcher representing the current method selection.

instrumentation

protected final Instrumentation instrumentation

The instrumentation that was defined for the current method selection.

attributeAppenderFactory

protected final MethodAttributeAppender.Factory attributeAppenderFactory

The method attribute appender factory that was defined for the current method selection.

Constructor Detail

MethodAnnotationTarget

protected MethodAnnotationTarget(ClassFileVersion classFileVersion,
                                 NamingStrategy namingStrategy,
                                 List<TypeDescription> interfaceTypes,
                                 MethodMatcher ignoredMethods,
                                 BridgeMethodResolver.Factory bridgeMethodResolverFactory,
                                 ClassVisitorWrapper.Chain classVisitorWrapperChain,
                                 MethodRegistry methodRegistry,
                                 ByteBuddy.Definable<Integer> modifiers,
                                 ByteBuddy.Definable<TypeAttributeAppender> typeAttributeAppender,
                                 FieldAttributeAppender.Factory defaultFieldAttributeAppenderFactory,
                                 MethodAttributeAppender.Factory defaultMethodAttributeAppenderFactory,
                                 MethodMatcher methodMatcher,
                                 Instrumentation instrumentation,
                                 MethodAttributeAppender.Factory attributeAppenderFactory)

Creates a new method annotation target.

Parameters:

classFileVersion - The currently defined class format version.

namingStrategy - The currently defined naming strategy.

interfaceTypes - The currently defined collection of interfaces to be implemented by any dynamically created type.

ignoredMethods - The methods to always be ignored.

bridgeMethodResolverFactory - The bridge method resolver factory to be applied to any instrumentation process.

classVisitorWrapperChain - The class visitor wrapper chain to be applied to any instrumentation process.

methodRegistry - The currently valid method registry.

modifiers - The modifiers to define for any instrumentation process.

typeAttributeAppender - The type attribute appender to apply to any instrumentation process.

defaultFieldAttributeAppenderFactory - The field attribute appender to apply as a default for any field definition.

defaultMethodAttributeAppenderFactory - The method attribute appender to apply as a default for any method definition or instrumentation.

methodMatcher - The method matcher representing the current method selection.

instrumentation - The instrumentation that was defined for the current method selection.

attributeAppenderFactory - The method attribute appender factory that was defined for the current method selection.

Method Detail

attribute

public ByteBuddy.MethodAnnotationTarget attribute(MethodAttributeAppender.Factory attributeAppenderFactory)

Defines a given attribute appender factory to be applied for the currently selected methods.

Parameters:

attributeAppenderFactory - The method attribute appender factory to apply to the currently selected methods.

Returns:

A method annotation target that represents the current configuration with the additional attribute appender factory applied to the current method selection.

annotateMethod

public ByteBuddy.MethodAnnotationTarget annotateMethod(Annotation... annotation)

Defines an method annotation for the currently selected methods.

Parameters:

annotation - The annotations to defined for the currently selected methods.

Returns:

A method annotation target that represents the current configuration with the additional annotations added to the currently selected methods.

annotateParameter

public ByteBuddy.MethodAnnotationTarget annotateParameter(int parameterIndex,
                                                          Annotation... annotation)

Defines an method annotation for a parameter of the currently selected methods.

Parameters:

parameterIndex - The index of the parameter for which the annotations should be applied with the first parameter index by 0.

annotation - The annotations to defined for the currently selected methods' parameters ath the given index.

Returns:

A method annotation target that represents the current configuration with the additional annotations added to the currently selected methods' parameters at the given index.

getClassFileVersion

public ClassFileVersion getClassFileVersion()

Description copied from class: ByteBuddy

Returns the class format version that is defined for the current configuration.

Overrides:

getClassFileVersion in class ByteBuddy

Returns:

The class format version that is defined for this configuration.

getNamingStrategy

public NamingStrategy getNamingStrategy()

Description copied from class: ByteBuddy

Returns the naming strategy for the current configuration.

Overrides:

getNamingStrategy in class ByteBuddy

Returns:

The naming strategy for the current configuration.

getInterfaceTypes

public List<TypeDescription> getInterfaceTypes()

Description copied from class: ByteBuddy

Returns the naming strategy for the current configuration.

Overrides:

getInterfaceTypes in class ByteBuddy

Returns:

The naming strategy for the current configuration.

getIgnoredMethods

public MethodMatcher getIgnoredMethods()

Description copied from class: ByteBuddy

Returns the matcher for the ignored methods for the current configuration.

Overrides:

getIgnoredMethods in class ByteBuddy

Returns:

The matcher for the ignored methods for the current configuration.

getClassVisitorWrapperChain

public ClassVisitorWrapper.Chain getClassVisitorWrapperChain()

Description copied from class: ByteBuddy

Returns the class visitor wrapper chain for the current configuration.

Overrides:

getClassVisitorWrapperChain in class ByteBuddy

Returns:

The class visitor wrapper chain for the current configuration.

getDefaultFieldAttributeAppenderFactory

public FieldAttributeAppender.Factory getDefaultFieldAttributeAppenderFactory()

Description copied from class: ByteBuddy

Returns the default field attribute appender factory which is applied to any field that is defined for instrumentations that are applied by this configuration.

Overrides:

getDefaultFieldAttributeAppenderFactory in class ByteBuddy

Returns:

The default field attribute appender factory which is applied to any field that is defined for instrumentations that are applied by this configuration.

getDefaultMethodAttributeAppenderFactory

public MethodAttributeAppender.Factory getDefaultMethodAttributeAppenderFactory()

Description copied from class: ByteBuddy

Returns the default method attribute appender factory which is applied to any method that is defined or intercepted for instrumentations that are applied by this configuration.

Overrides:

getDefaultMethodAttributeAppenderFactory in class ByteBuddy

Returns:

The default method attribute appender factory which is applied to any method that is defined or intercepted for instrumentations that are applied by this configuration.

subclass

public <T> DynamicType.Builder<T> subclass(Class<T> superType)

Description copied from class: ByteBuddy

Creates a dynamic type builder that creates a subclass of a given loaded type where the subclass is created by the ConstructorStrategy.Default.IMITATE_SUPER_TYPE strategy.

Overrides:

subclass in class ByteBuddy

Type Parameters:

T - The most specific known type that the created dynamic type represents.

Parameters:

superType - The type or interface to be extended or implemented by the dynamic type.

Returns:

A dynamic type builder for this configuration that extends or implements the given loaded type.

subclass

public <T> DynamicType.Builder<T> subclass(Class<T> superType,
                                           ConstructorStrategy constructorStrategy)

Description copied from class: ByteBuddy

Creates a dynamic type builder that creates a subclass of a given loaded type.

Overrides:

subclass in class ByteBuddy

Type Parameters:

T - The most specific known type that the created dynamic type represents.

Parameters:

superType - The type or interface to be extended or implemented by the dynamic type.

constructorStrategy - The constructor strategy to apply.

Returns:

A dynamic type builder for this configuration that extends or implements the given loaded type.

subclass

public <T> DynamicType.Builder<T> subclass(TypeDescription superType)

Description copied from class: ByteBuddy

Creates a dynamic type builder that creates a subclass of a given type description where the subclass is created by the ConstructorStrategy.Default.IMITATE_SUPER_TYPE strategy.

Overrides:

subclass in class ByteBuddy

Type Parameters:

T - The most specific known type that the created dynamic type represents.

Parameters:

superType - The type or interface to be extended or implemented by the dynamic type.

Returns:

A dynamic type builder for this configuration that extends or implements the given type description.

subclass

public <T> DynamicType.Builder<T> subclass(TypeDescription superType,
                                           ConstructorStrategy constructorStrategy)

Description copied from class: ByteBuddy

Creates a dynamic type builder that creates a subclass of a given type description.

Overrides:

subclass in class ByteBuddy

Type Parameters:

T - The most specific known type that the created dynamic type represents.

Parameters:

superType - The type or interface to be extended or implemented by the dynamic type.

constructorStrategy - The constructor strategy to apply.

Returns:

A dynamic type builder for this configuration that extends or implements the given type description.

withModifiers

public ByteBuddy withModifiers(ModifierContributor.ForType... modifierContributor)

Description copied from class: ByteBuddy

Defines a new modifier contributors for this configuration that replaces the currently defined modifier contributes which might currently be implicit.

Overrides:

withModifiers in class ByteBuddy

Parameters:

modifierContributor - The modifier contributors to define explicitly for this configuration.

Returns:

A new configuration that represents this configuration with the given modifier contributors.

withAttribute

public ByteBuddy withAttribute(TypeAttributeAppender typeAttributeAppender)

Description copied from class: ByteBuddy

Defines a new type attribute appender for this configuration that replaces the currently defined type attribute appender.

Overrides:

withAttribute in class ByteBuddy

Parameters:

typeAttributeAppender - The type attribute appender to define for this configuration.

Returns:

A new configuration that represents this configuration with the given type attribute appender.

withTypeAnnotation

public ByteBuddy withTypeAnnotation(Annotation... annotation)

Description copied from class: ByteBuddy

Defines a new type annotation for this configuration that replaces the currently defined type attribute appender.

Overrides:

withTypeAnnotation in class ByteBuddy

Parameters:

annotation - The type annotations to define for this configuration.

Returns:

A new configuration that represents this configuration with the given annotations as its new type attribute appender.

withClassFormatVersion

public ByteBuddy withClassFormatVersion(ClassFileVersion classFileVersion)

Description copied from class: ByteBuddy

Defines a new class format version for this configuration.

Overrides:

withClassFormatVersion in class ByteBuddy

Parameters:

classFileVersion - The class format version to define for this configuration.

Returns:

A new configuration that represents this configuration with the given class format version.

withNamingStrategy

public ByteBuddy withNamingStrategy(NamingStrategy namingStrategy)

Description copied from class: ByteBuddy

Defines a new naming strategy for this configuration.

Overrides:

withNamingStrategy in class ByteBuddy

Parameters:

namingStrategy - The class format version to define for this configuration.

Returns:

A new configuration that represents this configuration with the given class format version.

withImplementing

public ByteBuddy.OptionalMethodInterception withImplementing(Class<?> type)

Description copied from class: ByteBuddy

Defines all dynamic types that are created by this configuration to implement the given interface.

Overrides:

withImplementing in class ByteBuddy

Parameters:

type - The interface type to implement.

Returns:

This configuration where any dynamic type that is created by the resulting configuration will implement the given interface.

withImplementing

public ByteBuddy.OptionalMethodInterception withImplementing(TypeDescription type)

Description copied from class: ByteBuddy

Defines all dynamic types that are created by this configuration to implement the given interface.

Overrides:

withImplementing in class ByteBuddy

Parameters:

type - The interface type to implement.

Returns:

This configuration where any dynamic type that is created by the resulting configuration will implement the given interface.

withIgnoredMethods

public ByteBuddy withIgnoredMethods(MethodMatcher ignoredMethods)

Description copied from class: ByteBuddy

Defines a new method matcher for methods that are ignored by any dynamic type that is created by this configuration which will replace the current configuration. By default, this method matcher is defined to ignore instrumenting synthetic methods and the default finalizer method.

Overrides:

withIgnoredMethods in class ByteBuddy

Parameters:

ignoredMethods - The methods to always be ignored for any instrumentation.

Returns:

A new configuration that represents this configuration with the given method matcher defining methods that are to be ignored for any instrumentation.

withClassVisitor

public ByteBuddy withClassVisitor(ClassVisitorWrapper classVisitorWrapper)

Description copied from class: ByteBuddy

Defines a new class visitor to be appended to the current collection of ClassVisitors that are to be applied onto any creation process of a dynamic type.

Overrides:

withClassVisitor in class ByteBuddy

Parameters:

classVisitorWrapper - The class visitor wrapper to ba appended to the current chain of class visitor wrappers.

Returns:

This configuration with the given class visitor wrapper to be applied onto any creation process of a dynamic type.

withDefaultFieldAttributeAppender

public ByteBuddy withDefaultFieldAttributeAppender(FieldAttributeAppender.Factory attributeAppenderFactory)

Description copied from class: ByteBuddy

Defines a new default field attribute appender factory that is applied onto any field.

Overrides:

withDefaultFieldAttributeAppender in class ByteBuddy

Parameters:

attributeAppenderFactory - The attribute appender factory that is applied as a default on any field that is created by a dynamic type that is created with this configuration.

Returns:

This configuration with the given field attribute appender factory to be applied as a default to the creation process of any field of a dynamic type.

withDefaultMethodAttributeAppender

public ByteBuddy withDefaultMethodAttributeAppender(MethodAttributeAppender.Factory attributeAppenderFactory)

Description copied from class: ByteBuddy

Defines a new default method attribute appender factory that is applied onto any method.

Overrides:

withDefaultMethodAttributeAppender in class ByteBuddy

Parameters:

attributeAppenderFactory - The attribute appender factory that is applied as a default on any method that is created or intercepted by a dynamic type that is created with this configuration.

Returns:

This configuration with the given method attribute appender factory to be applied as a default to the creation or interception process of any method of a dynamic type.

invokable

public ByteBuddy.MatchedMethodInterception invokable(MethodMatcher methodMatcher)

Description copied from class: ByteBuddy

Intercepts a given selection of byte code methods that can be a method or a constructor.

Overrides:

invokable in class ByteBuddy

Parameters:

methodMatcher - The method matcher representing all byte code methods to intercept.

Returns:

A matched method interception for the given selection.

materialize

protected ByteBuddy materialize()

Materializes this configuration as new ByteBuddy instance.

Returns:

A ByteBuddy instance representing the current configuration.

equals

public boolean equals(Object other)

Overrides:

equals in class ByteBuddy

hashCode

public int hashCode()

Overrides:

hashCode in class ByteBuddy

toString

public String toString()

Overrides:

toString in class ByteBuddy