Class InvokeDynamic
- All Implemented Interfaces:
InstrumentedType.Prepareable
,Implementation
,Implementation.Composable
- Direct Known Subclasses:
InvokeDynamic.AbstractDelegator
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
An abstract delegator that allows to specify a configuration for any specification of an argument.protected class
The byte code appender to be used by theInvokeDynamic
implementation.protected static interface
An invocation provider is responsible for loading the arguments of the invoked method onto the operand stack and for creating the actual invoke dynamic instruction.protected static enum
A termination handler is responsible to handle the return value of a method that is invoked via aInvokeDynamic
.static class
Representation of anInvokeDynamic
implementation where the bootstrapped method is passed athis
reference, if available, and any arguments of the instrumented method.static class
Representation of anInvokeDynamic
implementation where the bootstrapped method is passed athis
reference, if available, and any arguments of the instrumented method and where the invocation target is implicit.static class
AnInvokeDynamic
invocation where the last argument is assigned its implicit type.Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation
Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target
Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable
InstrumentedType.Prepareable.NoOp
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final List
<? extends JavaConstant> The arguments that are provided to the bootstrap method.protected final Assigner
The assigner to be used.protected final MethodDescription.InDefinedShape
The bootstrap method.protected final InvokeDynamic.InvocationProvider
The target provided that identifies the method to be bootstrapped.protected final InvokeDynamic.TerminationHandler
A handler that handles the method return.protected final Assigner.Typing
Indicates if dynamic type castings should be attempted for incompatible assignments. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
InvokeDynamic
(MethodDescription.InDefinedShape bootstrap, List<? extends JavaConstant> arguments, InvokeDynamic.InvocationProvider invocationProvider, InvokeDynamic.TerminationHandler terminationHandler, Assigner assigner, Assigner.Typing typing) Creates a new invoke dynamic implementation. -
Method Summary
Modifier and TypeMethodDescriptionandThen
(Implementation implementation) Appends the supplied implementation to this implementation.andThen
(Implementation.Composable implementation) Appends the supplied composable implementation to this implementation.appender
(Implementation.Target implementationTarget) Creates a byte code appender that determines the implementation of the instrumented type's methods.bootstrap
(Constructor<?> constructor, Object... constant) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap constructor.bootstrap
(Constructor<?> constructor, List<?> constants) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap constructor.Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method.Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method.bootstrap
(MethodDescription.InDefinedShape bootstrap, Object... constant) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method or constructor.bootstrap
(MethodDescription.InDefinedShape bootstrap, List<?> constants) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method or constructor.Creates a lambda expression using the JVM's lambda meta factory.lambda
(Method method, Type functionalInterface, MethodGraph.Compiler methodGraphCompiler) Creates a lambda expression using the JVM's lambda meta factory.lambda
(MethodDescription.InDefinedShape methodDescription, TypeDefinition functionalInterface) Creates a lambda expression using the JVM's lambda meta factory.lambda
(MethodDescription.InDefinedShape methodDescription, TypeDefinition functionalInterface, MethodGraph.Compiler methodGraphCompiler) Creates a lambda expression using the JVM's lambda meta factory.prepare
(InstrumentedType instrumentedType) Prepares a given instrumented type.withArgument
(int index) Passes a parameter of the instrumented method to the bootstrapped method.withArgument
(int... index) Passes parameters of the instrumented method to the bootstrapped method.withAssigner
(Assigner assigner, Assigner.Typing typing) Instructs this implementation to use the provided assigner and decides if the assigner should apply dynamic typing.withBooleanValue
(boolean... value) Requires the bootstrap method to bootstrap a method that takes the specifiedboolean
arguments as its next parameters.withByteValue
(byte... value) Requires the bootstrap method to bootstrap a method that takes the specifiedbyte
arguments as its next parameters.withCharacterValue
(char... value) Requires the bootstrap method to bootstrap a method that takes the specifiedchar
arguments as its next parameters.withDoubleValue
(double... value) Requires the bootstrap method to bootstrap a method that takes the specifieddouble
arguments as its next parameters.withEnumeration
(EnumerationDescription... enumerationDescription) Hands the provided enumerations to the dynamically bound method.Passes the values of the specified fields to the bootstrap method.Passes the values of the specified fields to the bootstrap method.withField
(String name, FieldLocator.Factory fieldLocatorFactory) Passes the values of the specified fields to the bootstrap method.withField
(FieldLocator.Factory fieldLocatorFactory, String... name) Passes the values of the specified fields to the bootstrap method.withFloatValue
(float... value) Requires the bootstrap method to bootstrap a method that takes the specifiedfloat
arguments as its next parameters.Adds a potentialthis
reference and all method arguments to the the bootstrapped method.withInstance
(ConstantValue... constant) Hands the provided Java instance to the dynamically bound method.withInstance
(JavaConstant... constant) Hands the provided Java instance to the dynamically bound method.withIntegerValue
(int... value) Requires the bootstrap method to bootstrap a method that takes the specifiedint
arguments as its next parameters.withLongValue
(long... value) Requires the bootstrap method to bootstrap a method that takes the specifiedlong
arguments as its next parameters.Adds all method arguments to the the bootstrapped method.withNullValue
(Class<?>... type) Passesnull
values of the given types to the bootstrapped method.withNullValue
(TypeDescription... typeDescription) Passesnull
values of the given types to the bootstrapped method.withReference
(Object value) Requires the bootstrap method to bootstrap a method that takes the specified argument as its next parameter while allowing to specify the value to be of a different type than the actual instance type.withReference
(Object... value) Requires the bootstrap method to bootstrap a method that takes the specified arguments as its next parameters.withShortValue
(short... value) Requires the bootstrap method to bootstrap a method that takes the specifiedshort
arguments as its next parameters.Passes references tothis
onto the operand stack where the instance is represented as the given types.withThis
(TypeDescription... typeDescription) Passes references tothis
onto the operand stack where the instance is represented as the given types.withType
(TypeDescription... typeDescription) Hands the provided types to the dynamically bound method.Requires the bootstrap method to bootstrap a method that takes the specified arguments as its next parameters.
-
Field Details
-
bootstrap
The bootstrap method. -
arguments
The arguments that are provided to the bootstrap method. -
invocationProvider
The target provided that identifies the method to be bootstrapped. -
terminationHandler
A handler that handles the method return. -
assigner
The assigner to be used. -
typing
Indicates if dynamic type castings should be attempted for incompatible assignments.
-
-
Constructor Details
-
InvokeDynamic
protected InvokeDynamic(MethodDescription.InDefinedShape bootstrap, List<? extends JavaConstant> arguments, InvokeDynamic.InvocationProvider invocationProvider, InvokeDynamic.TerminationHandler terminationHandler, Assigner assigner, Assigner.Typing typing) Creates a new invoke dynamic implementation.- Parameters:
bootstrap
- The bootstrap method.arguments
- The arguments that are provided to the bootstrap method.invocationProvider
- The target provided that identifies the method to be bootstrapped.terminationHandler
- A handler that handles the method return.assigner
- The assigner to be used.typing
- Indicates if dynamic type castings should be attempted for incompatible assignments.
-
-
Method Details
-
bootstrap
Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method.- Parameters:
method
- The bootstrap method that is used to link the instrumented method.constant
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
bootstrap
Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method.- Parameters:
method
- The bootstrap method that is used to link the instrumented method.constants
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
bootstrap
public static InvokeDynamic.WithImplicitTarget bootstrap(Constructor<?> constructor, Object... constant) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap constructor.- Parameters:
constructor
- The bootstrap constructor that is used to link the instrumented method.constant
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
bootstrap
public static InvokeDynamic.WithImplicitTarget bootstrap(Constructor<?> constructor, List<?> constants) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap constructor.- Parameters:
constructor
- The bootstrap constructor that is used to link the instrumented method.constants
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
bootstrap
public static InvokeDynamic.WithImplicitTarget bootstrap(MethodDescription.InDefinedShape bootstrap, Object... constant) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method or constructor.- Parameters:
bootstrap
- The bootstrap method or constructor that is used to link the instrumented method.constant
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
bootstrap
public static InvokeDynamic.WithImplicitTarget bootstrap(MethodDescription.InDefinedShape bootstrap, List<?> constants) Implements the instrumented method with a dynamic method invocation which is linked at runtime using the specified bootstrap method or constructor.- Parameters:
bootstrap
- The bootstrap method or constructor that is used to link the instrumented method.constants
- The constant values passed to the bootstrap method. Values can be represented either asTypeDescription
, asJavaConstant
, asString
or a primitiveint
,long
,float
ordouble
represented as wrapper type.- Returns:
- An implementation where a
this
reference, if available, and all arguments of the instrumented method are passed to the bootstrapped method unless explicit parameters are specified.
-
lambda
Creates a lambda expression using the JVM's lambda meta factory. The method that is implementing the lambda expression is provided the explicit arguments first and the functional interface's method second.
Important: Byte Buddy does not validate that the provided arguments are correct considering the required arguments of the bound functional interface. Binding an incorrect number of arguments or arguments of incompatible types does not create illegal byte code but yields a runtime error when the call site is first used. This is done to support future extensions or alternative implementations of the Java virtual machine.
- Parameters:
method
- The method that implements the lambda expression.functionalInterface
- The functional interface that is an instance of the lambda expression.- Returns:
- A builder for creating a lambda expression.
-
lambda
public static InvokeDynamic.WithImplicitArguments lambda(Method method, Type functionalInterface, MethodGraph.Compiler methodGraphCompiler) Creates a lambda expression using the JVM's lambda meta factory. The method that is implementing the lambda expression is provided the explicit arguments first and the functional interface's method second.
Important: Byte Buddy does not validate that the provided arguments are correct considering the required arguments of the bound functional interface. Binding an incorrect number of arguments or arguments of incompatible types does not create illegal byte code but yields a runtime error when the call site is first used. This is done to support future extensions or alternative implementations of the Java virtual machine.
- Parameters:
method
- The method that implements the lambda expression.functionalInterface
- The functional interface that is an instance of the lambda expression.methodGraphCompiler
- The method graph compiler to use.- Returns:
- A builder for creating a lambda expression.
-
lambda
public static InvokeDynamic.WithImplicitArguments lambda(MethodDescription.InDefinedShape methodDescription, TypeDefinition functionalInterface) Creates a lambda expression using the JVM's lambda meta factory. The method that is implementing the lambda expression is provided the explicit arguments first and the functional interface's method second.
Important: Byte Buddy does not validate that the provided arguments are correct considering the required arguments of the bound functional interface. Binding an incorrect number of arguments or arguments of incompatible types does not create illegal byte code but yields a runtime error when the call site is first used. This is done to support future extensions or alternative implementations of the Java virtual machine.
- Parameters:
methodDescription
- The method that implements the lambda expression.functionalInterface
- The functional interface that is an instance of the lambda expression.- Returns:
- A builder for creating a lambda expression.
-
lambda
public static InvokeDynamic.WithImplicitArguments lambda(MethodDescription.InDefinedShape methodDescription, TypeDefinition functionalInterface, MethodGraph.Compiler methodGraphCompiler) Creates a lambda expression using the JVM's lambda meta factory. The method that is implementing the lambda expression is provided the explicit arguments first and the functional interface's method second.
Important: Byte Buddy does not validate that the provided arguments are correct considering the required arguments of the bound functional interface. Binding an incorrect number of arguments or arguments of incompatible types does not create illegal byte code but yields a runtime error when the call site is first used. This is done to support future extensions or alternative implementations of the Java virtual machine.
- Parameters:
methodDescription
- The method that implements the lambda expression.functionalInterface
- The functional interface that is an instance of the lambda expression.methodGraphCompiler
- The method graph compiler to use.- Returns:
- A builder for creating a lambda expression.
-
withBooleanValue
Requires the bootstrap method to bootstrap a method that takes the specifiedboolean
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withByteValue
Requires the bootstrap method to bootstrap a method that takes the specifiedbyte
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withShortValue
Requires the bootstrap method to bootstrap a method that takes the specifiedshort
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withCharacterValue
Requires the bootstrap method to bootstrap a method that takes the specifiedchar
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withIntegerValue
Requires the bootstrap method to bootstrap a method that takes the specifiedint
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withLongValue
Requires the bootstrap method to bootstrap a method that takes the specifiedlong
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withFloatValue
Requires the bootstrap method to bootstrap a method that takes the specifiedfloat
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withDoubleValue
Requires the bootstrap method to bootstrap a method that takes the specifieddouble
arguments as its next parameters.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withValue
Requires the bootstrap method to bootstrap a method that takes the specified arguments as its next parameters. Note that any primitive parameters are passed as their wrapper types. Furthermore, values that can be stored in the instrumented class's constant pool might be of different object identity when passed to the bootstrapped method or might not be visible to the the created class what later results in a runtime error.
- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withReference
Requires the bootstrap method to bootstrap a method that takes the specified argument as its next parameter while allowing to specify the value to be of a different type than the actual instance type.
- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withReference
Requires the bootstrap method to bootstrap a method that takes the specified arguments as its next parameters. Note that any primitive parameters are passed as their wrapper types. Any value that is passed to the bootstrapped method is guaranteed to be of the same object identity.- Parameters:
value
- The arguments to pass to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withType
Hands the provided types to the dynamically bound method. The type is stored in the generated class's constant pool and is loaded at invocation time. For this to be possible, the created class's class loader must be able to see the provided type.- Parameters:
typeDescription
- The classes to provide to the bound method as an argument.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified type.
-
withEnumeration
Hands the provided enumerations to the dynamically bound method. The enumeration values are read from the enumeration class on demand. For this to be possible, the created class's class loader must be able to see the enumeration type.- Parameters:
enumerationDescription
- The enumeration values to provide to the bound method as an argument.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified enumerations.
-
withInstance
Hands the provided Java instance to the dynamically bound method. The instance is stored in the generated class's constant pool and is loaded at invocation time. For this to be possible, the created class's class loader must be able to create the provided Java instance.- Parameters:
constant
- The constants to provide to the bound method as an argument.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified Java instance.
-
withInstance
Hands the provided Java instance to the dynamically bound method. The instance is stored in the generated class's constant pool and is loaded at invocation time. For this to be possible, the created class's class loader must be able to create the provided Java instance.- Parameters:
constant
- The constants to provide to the bound method as an argument.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified Java instance.
-
withNullValue
Passesnull
values of the given types to the bootstrapped method.- Parameters:
type
- The type that thenull
values should represent.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withNullValue
Passesnull
values of the given types to the bootstrapped method.- Parameters:
typeDescription
- The type that thenull
values should represent.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withArgument
Passes parameters of the instrumented method to the bootstrapped method.- Parameters:
index
- The indices of the parameters that should be passed to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withArgument
Passes a parameter of the instrumented method to the bootstrapped method.- Parameters:
index
- The index of the parameter that should be passed to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified argument with its implicit type.
-
withThis
Passes references tothis
onto the operand stack where the instance is represented as the given types.- Parameters:
type
- The types as which thethis
reference of the intercepted method should be masked.- Returns:
- This implementation where
this
references are passed as the next arguments.
-
withThis
Passes references tothis
onto the operand stack where the instance is represented as the given types.- Parameters:
typeDescription
- The types as which thethis
reference of the intercepted method should be masked.- Returns:
- This implementation where
this
references are passed as the next arguments.
-
withMethodArguments
Adds all method arguments to the the bootstrapped method.- Returns:
- This invoke dynamic implementation with all parameters of the instrumented method added.
-
withImplicitAndMethodArguments
Adds a potentialthis
reference and all method arguments to the the bootstrapped method.- Returns:
- This invoke dynamic implementation with a potential
this
reference and all parameters of the instrumented method added.
-
withField
Passes the values of the specified fields to the bootstrap method. Any of the specified fields must already exist for the instrumented type.- Parameters:
name
- The names of the fields to be passed to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withField
Passes the values of the specified fields to the bootstrap method. Any of the specified fields must already exist for the instrumented type.- Parameters:
fieldLocatorFactory
- The field locator factory to use.name
- The names of the fields to be passed to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withField
Passes the values of the specified fields to the bootstrap method. Any of the specified fields must already exist for the instrumented type.- Parameters:
name
- The names of the fields to be passed to the bootstrapped method.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withField
public InvokeDynamic.WithImplicitType withField(String name, FieldLocator.Factory fieldLocatorFactory) Passes the values of the specified fields to the bootstrap method. Any of the specified fields must already exist for the instrumented type.- Parameters:
name
- The names of the fields to be passed to the bootstrapped method.fieldLocatorFactory
- The field locator factory to use.- Returns:
- This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.
-
withAssigner
Instructs this implementation to use the provided assigner and decides if the assigner should apply dynamic typing.- Parameters:
assigner
- The assigner to use.typing
-true
if the assigner should attempt dynamic typing.- Returns:
- The invoke dynamic instruction where the given assigner and dynamic-typing directive are applied.
-
andThen
Appends the supplied implementation to this implementation.- Specified by:
andThen
in interfaceImplementation.Composable
- Parameters:
implementation
- The subsequent implementation.- Returns:
- An implementation that combines this implementation with the provided one.
-
andThen
Appends the supplied composable implementation to this implementation.- Specified by:
andThen
in interfaceImplementation.Composable
- Parameters:
implementation
- The subsequent composable implementation.- Returns:
- A composable implementation that combines this implementation with the provided one.
-
prepare
Prepares a given instrumented type.- Specified by:
prepare
in interfaceInstrumentedType.Prepareable
- Parameters:
instrumentedType
- The instrumented type in its current form.- Returns:
- The prepared instrumented type.
-
appender
Creates a byte code appender that determines the implementation of the instrumented type's methods.- Specified by:
appender
in interfaceImplementation
- Parameters:
implementationTarget
- The target of the current implementation.- Returns:
- 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
InstrumentedType.Prepareable.prepare(InstrumentedType)
.
-