net.bytebuddy

Class ByteBuddy.OptionalMethodInterception

java.lang.Object

net.bytebuddy.ByteBuddy

net.bytebuddy.ByteBuddy.OptionalMethodInterception

All Implemented Interfaces:

ByteBuddy.MethodInterceptable

Enclosing class:

ByteBuddy

public static class ByteBuddy.OptionalMethodInterception
extends ByteBuddy
implements ByteBuddy.MethodInterceptable

An optional method interception that allows to intercept a method selection only if this is needed.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected LatentMethodMatcher	methodMatcher The method matcher that defines the selected that is represented by this instance.

Fields inherited from class net.bytebuddy.ByteBuddy

auxiliaryTypeNamingStrategy, BYTE_BUDDY_DEFAULT_PREFIX, BYTE_BUDDY_DEFAULT_SUFFIX, classFileVersion, classVisitorWrapperChain, defaultFieldAttributeAppenderFactory, defaultMethodAttributeAppenderFactory, ignoredMethods, interfaceTypes, methodGraphCompiler, methodRegistry, modifiers, namingStrategy, typeAttributeAppender

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

OptionalMethodInterception(ClassFileVersion classFileVersion, NamingStrategy.Unbound namingStrategy, AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy, List<TypeDescription> interfaceTypes, ElementMatcher<? super MethodDescription> ignoredMethods, ClassVisitorWrapper.Chain classVisitorWrapperChain, MethodRegistry methodRegistry, ByteBuddy.Definable<Integer> modifiers, TypeAttributeAppender typeAttributeAppender, MethodGraph.Compiler methodGraphCompiler, FieldAttributeAppender.Factory defaultFieldAttributeAppenderFactory, MethodAttributeAppender.Factory defaultMethodAttributeAppenderFactory, LatentMethodMatcher methodMatcher) Creates a new optional method interception.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
int	hashCode()
ByteBuddy.MethodAnnotationTarget	intercept(Implementation implementation) Intercepts the currently selected methods with the provided implementation.
String	toString()
ByteBuddy.MethodAnnotationTarget	withDefaultValue(Object value) Defines a default annotation value to set for any matched method.
ByteBuddy.MethodAnnotationTarget	withDefaultValue(Object value, Class<?> type) Defines a default annotation value to set for any matched method.
ByteBuddy.MethodAnnotationTarget	withoutCode() Implements the currently selected methods as abstract methods.

Methods inherited from class net.bytebuddy.ByteBuddy

constructor, getAuxiliaryTypeNamingStrategy, getClassFileVersion, getClassVisitorWrapperChain, getDefaultFieldAttributeAppenderFactory, getDefaultMethodAttributeAppenderFactory, getIgnoredMethods, getInterfaceTypes, getMethodGraphCompiler, getMethodRegistry, getModifiers, getNamingStrategy, getTypeAttributeAppender, invokable, invokable, makeAnnotation, makeEnumeration, makeEnumeration, makeInterface, makeInterface, makeInterface, makeInterface, makeInterface, makeInterface, makePackage, method, rebase, rebase, rebase, rebase, rebase, rebase, rebase, redefine, redefine, redefine, subclass, subclass, subclass, subclass, withAttribute, withClassFileVersion, withClassVisitor, withDefaultFieldAttributeAppender, withDefaultMethodAttributeAppender, withIgnoredMethods, withImplementing, withImplementing, withImplementing, withImplementing, withMethodGraphCompiler, withModifiers, withNamingStrategy, withNamingStrategy, withNamingStrategy, withTypeAnnotation, withTypeAnnotation, withTypeAnnotation, withTypeAnnotation

Methods inherited from class java.lang.Object

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

Field Detail

methodMatcher

protected final LatentMethodMatcher methodMatcher

The method matcher that defines the selected that is represented by this instance.

Constructor Detail

OptionalMethodInterception

protected OptionalMethodInterception(ClassFileVersion classFileVersion,
                                     NamingStrategy.Unbound namingStrategy,
                                     AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy,
                                     List<TypeDescription> interfaceTypes,
                                     ElementMatcher<? super MethodDescription> ignoredMethods,
                                     ClassVisitorWrapper.Chain classVisitorWrapperChain,
                                     MethodRegistry methodRegistry,
                                     ByteBuddy.Definable<Integer> modifiers,
                                     TypeAttributeAppender typeAttributeAppender,
                                     MethodGraph.Compiler methodGraphCompiler,
                                     FieldAttributeAppender.Factory defaultFieldAttributeAppenderFactory,
                                     MethodAttributeAppender.Factory defaultMethodAttributeAppenderFactory,
                                     LatentMethodMatcher methodMatcher)

Creates a new optional method interception.

Parameters:

classFileVersion - The currently defined class file version.

namingStrategy - The currently defined naming strategy.

auxiliaryTypeNamingStrategy - The currently defined naming strategy for auxiliary types.

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

ignoredMethods - The methods to always be ignored. process.

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

methodRegistry - The currently valid method registry.

modifiers - The modifiers to define for any implementation process.

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

methodGraphCompiler - The method graph compiler to use.

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 implementation.

methodMatcher - The method matcher representing the current method selection.

Method Detail

intercept

public ByteBuddy.MethodAnnotationTarget intercept(Implementation implementation)

Description copied from interface: ByteBuddy.MethodInterceptable

Intercepts the currently selected methods with the provided implementation. If this intercepted method is not yet declared by the current type, it might be added to the currently built type as a result of this interception. If the method is already declared by the current type, its byte code code might be copied into the body of a synthetic method in order to preserve the original code's invokeability.

Specified by:

intercept in interface ByteBuddy.MethodInterceptable

Parameters:

implementation - The implementation to apply to the currently selected method.

Returns:

A configuration which will intercept the currently selected methods by the given implementation.

withoutCode

public ByteBuddy.MethodAnnotationTarget withoutCode()

Description copied from interface: ByteBuddy.MethodInterceptable

Implements the currently selected methods as abstract methods.

Specified by:

withoutCode in interface ByteBuddy.MethodInterceptable

Returns:

A configuration which will implement the currently selected methods as abstract methods.

withDefaultValue

public ByteBuddy.MethodAnnotationTarget withDefaultValue(Object value,
                                                         Class<?> type)

Description copied from interface: ByteBuddy.MethodInterceptable

Defines a default annotation value to set for any matched method.

Specified by:

withDefaultValue in interface ByteBuddy.MethodInterceptable

Parameters:

value - The value that the annotation property should set as a default.

type - The type of the annotation property.

Returns:

A configuration which defines the given default value for all matched methods.

withDefaultValue

public ByteBuddy.MethodAnnotationTarget withDefaultValue(Object value)

Description copied from interface: ByteBuddy.MethodInterceptable

Defines a default annotation value to set for any matched method. The value is to be represented in a wrapper format, enum values should be handed as EnumerationDescription instances, annotations as AnnotationDescription instances and Class values as TypeDescription instances. Other values are handed in their actual form or as their wrapper types.

Specified by:

withDefaultValue in interface ByteBuddy.MethodInterceptable

Parameters:

value - A non-loaded value that the annotation property should set as a default.

Returns:

A configuration which defines the given default value for all matched methods.

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