This Implementation invokes a default method for the methods it instruments. A default method is potentially ambiguous if a method of identical signature is defined in several interfaces. For this reason, this implementation allows for the specification of prioritized interfaces whose default methods, if a method of equivalent signature is defined for a specific interface. All prioritized interfaces are searched for default methods in the order of their specification. If no prioritized interface defines a default method of equivalent signature to the given instrumented method, any non-prioritized interface is searched for a suitable default method. If exactly one of those interfaces defines a suitable default method, this method is invoked. If no method or more than one method is identified as a suitable default method, an exception is thrown.

When it comes to default methods, the Java programming language specifies stronger requirements for the legitimacy of invoking a default method than the Java runtime. The Java compiler requires a method to be the most specific method in its defining type's type hierarchy, i.e. the method must not be overridden by another interface or class type. Additionally, the method must be invokable from an interface type which is directly implemented by the instrumented type. The Java runtime only requires the second condition to be fulfilled which is why this implementation only checks the later condition, as well.

Modifier and Type	Class and Description
protected static class	DefaultMethodCall.Appender The appender for implementing a `net.bytebuddy.implementation.DefaultMethodCall`.

Field Summary

Modifier and Type	Field and Description
private final List<TypeDescription>	prioritizedInterfaces A list of prioritized interfaces in the order in which a method should be attempted to be called.

Access	Constructor and Description
protected	DefaultMethodCall(List<TypeDescription> A list of prioritized interfaces in the order in which a method should be attempted to be called. prioritizedInterfaces) Creates a new `net.bytebuddy.implementation.DefaultMethodCall` implementation for a given list of prioritized interfaces.

Method Summary

Modifier and Type	Method and Description
public ByteCodeAppender	appender(Implementation.Target The target of the current implementation. implementationTarget) Implements net.bytebuddy.implementation.Implementation.appender. Creates a byte code appender that determines the implementation of the instrumented type's methods.
private List<TypeDescription>	Returns: A list of prioritized interfaces that are additionally implemented by the given type. filterRelevant(TypeDescription The instrumented type for which the prioritized interfaces are to be filtered. typeDescription) Filters the relevant prioritized interfaces for a given type, i.e. finds the types that are directly declared on a given instrumented type.
public InstrumentedType	prepare(InstrumentedType The instrumented type in its current form. instrumentedType) Implements net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable.prepare. Prepares a given instrumented type.
public static Implementation	Returns: An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order. prioritize(Class<?>... A list of prioritized default method interfaces in their prioritization order. prioritizedInterface) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order.
public static Implementation	Returns: An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order. prioritize(Iterable<? extends Class<?>> A list of prioritized default method interfaces in their prioritization order. prioritizedInterfaces) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order.
public static Implementation	Returns: An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order. prioritize(TypeDescription... A list of prioritized default method interfaces in their prioritization order. prioritizedInterface) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order.
public static Implementation	Returns: An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order. prioritize(Collection<? extends TypeDescription> A collection of prioritized default method interfaces in their prioritization order. prioritizedInterfaces) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order.
public static Implementation	Returns: An implementation which calls an instrumented method's compatible default method if such a method is unambiguous. unambiguousOnly() Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation without prioritizing any interface.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

prioritizedInterfaces	back to summary
private final List<TypeDescription> prioritizedInterfaces A list of prioritized interfaces in the order in which a method should be attempted to be called.

Constructor Detail

DefaultMethodCall back to summary

DefaultMethodCall	back to summary
protected DefaultMethodCall(List<TypeDescription> prioritizedInterfaces) Creates a new `net.bytebuddy.implementation.DefaultMethodCall` implementation for a given list of prioritized interfaces. Parameters prioritizedInterfaces:List<TypeDescription> A list of prioritized interfaces in the order in which a method should be attempted to be called.

protected DefaultMethodCall(List<TypeDescription> prioritizedInterfaces)

Creates a new net.bytebuddy.implementation.DefaultMethodCall implementation for a given list of prioritized interfaces.

Parameters

prioritizedInterfaces:List<TypeDescription>: A list of prioritized interfaces in the order in which a method should be attempted to be called.

Method Detail

appender back to summary

appender	back to summary
public ByteCodeAppender appender(Implementation.Target implementationTarget) Implements net.bytebuddy.implementation.Implementation.appender. Doc from net.bytebuddy.implementation.Implementation.appender. Creates a byte code appender that determines the implementation of the instrumented type's methods. Parameters implementationTarget:Implementation.Target The target of the current implementation. Returns:ByteCodeAppender A byte code appender for implementing methods delegated to this implementation. This byte code appender is also responsible for handling methods that were added by this implementation on the call to `Implementation#prepare(InstrumentedType)`.

public ByteCodeAppender appender(Implementation.Target implementationTarget)

Implements net.bytebuddy.implementation.Implementation.appender.

Doc from net.bytebuddy.implementation.Implementation.appender.

Creates a byte code appender that determines the implementation of the instrumented type's methods.

Parameters

implementationTarget:Implementation.Target: The target of the current implementation.

Returns:ByteCodeAppender

A byte code appender for implementing methods delegated to this implementation. This byte code appender is also responsible for handling methods that were added by this implementation on the call to Implementation#prepare(InstrumentedType).

filterRelevant	back to summary
private List<TypeDescription> filterRelevant(TypeDescription typeDescription) Filters the relevant prioritized interfaces for a given type, i.e. finds the types that are directly declared on a given instrumented type. Parameters typeDescription:TypeDescription The instrumented type for which the prioritized interfaces are to be filtered. Returns:List<TypeDescription> A list of prioritized interfaces that are additionally implemented by the given type.

filterRelevant

back to summary

private List<TypeDescription> filterRelevant(TypeDescription typeDescription)

Filters the relevant prioritized interfaces for a given type, i.e. finds the types that are directly declared on a given instrumented type.

Parameters

typeDescription:TypeDescription: The instrumented type for which the prioritized interfaces are to be filtered.

Returns:List<TypeDescription>

A list of prioritized interfaces that are additionally implemented by the given type.

prepare	back to summary
public InstrumentedType prepare(InstrumentedType instrumentedType) Implements net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable.prepare. Doc from net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable.prepare. Prepares a given instrumented type. Parameters instrumentedType:InstrumentedType The instrumented type in its current form. Returns:InstrumentedType The prepared instrumented type.

prepare

back to summary

public InstrumentedType prepare(InstrumentedType instrumentedType)

Implements net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable.prepare.

Doc from net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable.prepare.

Prepares a given instrumented type.

Parameters

instrumentedType:InstrumentedType: The instrumented type in its current form.

Returns:InstrumentedType

The prepared instrumented type.

prioritize back to summary

prioritize	back to summary
public static Implementation prioritize(Class<?>... prioritizedInterface) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order. If no such prioritized interface is suitable, because it is either not defined on the instrumented type or because it does not define a suitable default method, any remaining interface is searched for a suitable default method. If no or more than one method defines a suitable default method, an exception is thrown. Parameters prioritizedInterface:Class<?>[] A list of prioritized default method interfaces in their prioritization order. Returns:Implementation An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

public static Implementation prioritize(Class<?>... prioritizedInterface)

Creates a net.bytebuddy.implementation.DefaultMethodCall implementation which searches the given list of interface types for a suitable default method in their order. If no such prioritized interface is suitable, because it is either not defined on the instrumented type or because it does not define a suitable default method, any remaining interface is searched for a suitable default method. If no or more than one method defines a suitable default method, an exception is thrown.

Parameters

prioritizedInterface:Class<?>[]: A list of prioritized default method interfaces in their prioritization order.

Returns:Implementation

An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

prioritize back to summary

prioritize	back to summary
public static Implementation prioritize(Iterable<? extends Class<?>> prioritizedInterfaces) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order. If no such prioritized interface is suitable, because it is either not defined on the instrumented type or because it does not define a suitable default method, any remaining interface is searched for a suitable default method. If no or more than one method defines a suitable default method, an exception is thrown. Parameters prioritizedInterfaces:Iterable<? extends Class<?>> A list of prioritized default method interfaces in their prioritization order. Returns:Implementation An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

public static Implementation prioritize(Iterable<? extends Class<?>> prioritizedInterfaces)

Parameters

prioritizedInterfaces:Iterable<? extends Class<?>>: A list of prioritized default method interfaces in their prioritization order.

Returns:Implementation

An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

prioritize back to summary

prioritize	back to summary
public static Implementation prioritize(TypeDescription... prioritizedInterface) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order. If no such prioritized interface is suitable, because it is either not defined on the instrumented type or because it does not define a suitable default method, any remaining interface is searched for a suitable default method. If no or more than one method defines a suitable default method, an exception is thrown. Parameters prioritizedInterface:TypeDescription[] A list of prioritized default method interfaces in their prioritization order. Returns:Implementation An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

public static Implementation prioritize(TypeDescription... prioritizedInterface)

Parameters

prioritizedInterface:TypeDescription[]: A list of prioritized default method interfaces in their prioritization order.

Returns:Implementation

An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

prioritize back to summary

prioritize	back to summary
public static Implementation prioritize(Collection<? extends TypeDescription> prioritizedInterfaces) Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation which searches the given list of interface types for a suitable default method in their order. If no such prioritized interface is suitable, because it is either not defined on the instrumented type or because it does not define a suitable default method, any remaining interface is searched for a suitable default method. If no or more than one method defines a suitable default method, an exception is thrown. Parameters prioritizedInterfaces:Collection<? extends TypeDescription> A collection of prioritized default method interfaces in their prioritization order. Returns:Implementation An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

public static Implementation prioritize(Collection<? extends TypeDescription> prioritizedInterfaces)

Parameters

prioritizedInterfaces:Collection<? extends TypeDescription>: A collection of prioritized default method interfaces in their prioritization order.

Returns:Implementation

An implementation which calls an instrumented method's compatible default method that considers the given interfaces to be prioritized in their order.

unambiguousOnly back to summary

unambiguousOnly	back to summary
public static Implementation unambiguousOnly() Creates a `net.bytebuddy.implementation.DefaultMethodCall` implementation without prioritizing any interface. Instead, any interface that is defined for a given type is searched for a suitable default method. If exactly one interface defines a suitable default method, this method is invoked from the instrumented method. Otherwise, an exception is thrown. Returns:Implementation An implementation which calls an instrumented method's compatible default method if such a method is unambiguous.

public static Implementation unambiguousOnly()

Creates a net.bytebuddy.implementation.DefaultMethodCall implementation without prioritizing any interface. Instead, any interface that is defined for a given type is searched for a suitable default method. If exactly one interface defines a suitable default method, this method is invoked from the instrumented method. Otherwise, an exception is thrown.

Returns:Implementation: An implementation which calls an instrumented method's compatible default method if such a method is unambiguous.

net.bytebuddy.implementation back to summary

protected Class DefaultMethodCall.Appender

Class Inheritance

extends Object
implements ByteCodeAppender

java.lang.Object
net.bytebuddy.implementation.DefaultMethodCall.Appender

All Implemented Interfaces

net.bytebuddy.implementation.bytecode.ByteCodeAppender

Annotations

@Enhance

The appender for implementing a net.bytebuddy.implementation.DefaultMethodCall.

Field Summary

Modifier and Type	Field and Description
private final Implementation.Target	implementationTarget The implementation target of this appender.
private final Set<TypeDescription>	nonPrioritizedInterfaces The relevant non-prioritized interfaces to be considered by this appender.
private final List<TypeDescription>	prioritizedInterfaces The relevant prioritized interfaces to be considered by this appender.

Constructor Summary

Access	Constructor and Description
protected	Appender(Implementation.Target The implementation target of this appender. implementationTarget, List<TypeDescription> The relevant prioritized interfaces to be considered by this appender. prioritizedInterfaces) Creates a new appender for implementing a `net.bytebuddy.implementation.DefaultMethodCall`.

Method Summary

Modifier and Type	Method and Description
public ByteCodeAppender.Size	apply(MethodVisitor The method visitor to which the byte code appender writes its code to. methodVisitor, Implementation.Context The implementation context of the current type creation process. implementationContext, MethodDescription The method that is the target of the instrumentation. instrumentedMethod) Implements net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply. Applies this byte code appender to a type creation process.
private StackManipulation	Returns: A potentially illegal stack manipulation representing the default method invocation for the given method. locateDefault(MethodDescription The method that is currently instrumented. methodDescription) Locates a special method invocation to be invoked from a given method.

Modifier and Type

Method and Description

public ByteCodeAppender.Size

apply(MethodVisitor

The method visitor to which the byte code appender writes its code to.

methodVisitor, Implementation.Context

The implementation context of the current type creation process.

implementationContext, MethodDescription

The method that is the target of the instrumentation.

instrumentedMethod)

Implements net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply.

Applies this byte code appender to a type creation process.

private StackManipulation

Returns:

A potentially illegal stack manipulation representing the default method invocation for the given method.

locateDefault(MethodDescription

The method that is currently instrumented.

methodDescription)

Locates a special method invocation to be invoked from a given method.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

implementationTarget	back to summary
private final Implementation.Target implementationTarget The implementation target of this appender.

nonPrioritizedInterfaces	back to summary
private final Set<TypeDescription> nonPrioritizedInterfaces The relevant non-prioritized interfaces to be considered by this appender. Annotations @ValueHandling:IGNORE

prioritizedInterfaces	back to summary
private final List<TypeDescription> prioritizedInterfaces The relevant prioritized interfaces to be considered by this appender.

Constructor Detail

Appender back to summary

Appender	back to summary
protected Appender(Implementation.Target implementationTarget, List<TypeDescription> prioritizedInterfaces) Creates a new appender for implementing a `net.bytebuddy.implementation.DefaultMethodCall`. Parameters implementationTarget:Implementation.Target The implementation target of this appender. prioritizedInterfaces:List<TypeDescription> The relevant prioritized interfaces to be considered by this appender.

protected Appender(Implementation.Target implementationTarget, List<TypeDescription> prioritizedInterfaces)

Creates a new appender for implementing a net.bytebuddy.implementation.DefaultMethodCall.

Parameters

implementationTarget:Implementation.Target: The implementation target of this appender.
prioritizedInterfaces:List<TypeDescription>: The relevant prioritized interfaces to be considered by this appender.

Method Detail

apply	back to summary
public ByteCodeAppender.Size apply(MethodVisitor methodVisitor, Implementation.Context implementationContext, MethodDescription instrumentedMethod) Implements net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply. Doc from net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply. Applies this byte code appender to a type creation process. Parameters methodVisitor:MethodVisitor The method visitor to which the byte code appender writes its code to. implementationContext:Implementation.Context The implementation context of the current type creation process. instrumentedMethod:MethodDescription The method that is the target of the instrumentation. Returns:ByteCodeAppender.Size The required size for the applied byte code to run.

apply

back to summary

public ByteCodeAppender.Size apply(MethodVisitor methodVisitor, Implementation.Context implementationContext, MethodDescription instrumentedMethod)

Implements net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply.

Doc from net.bytebuddy.implementation.bytecode.ByteCodeAppender.apply.

Applies this byte code appender to a type creation process.

Parameters

methodVisitor:MethodVisitor: The method visitor to which the byte code appender writes its code to.
implementationContext:Implementation.Context: The implementation context of the current type creation process.
instrumentedMethod:MethodDescription: The method that is the target of the instrumentation.

Returns:ByteCodeAppender.Size

The required size for the applied byte code to run.

locateDefault	back to summary
private StackManipulation locateDefault(MethodDescription methodDescription) Locates a special method invocation to be invoked from a given method. Parameters methodDescription:MethodDescription The method that is currently instrumented. Returns:StackManipulation A potentially illegal stack manipulation representing the default method invocation for the given method.

locateDefault

back to summary

private StackManipulation locateDefault(MethodDescription methodDescription)

Locates a special method invocation to be invoked from a given method.

Parameters

methodDescription:MethodDescription: The method that is currently instrumented.

Returns:StackManipulation

A potentially illegal stack manipulation representing the default method invocation for the given method.

public Class DefaultMethodCall

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class DefaultMethodCall.Appender

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail