Class InvokeDynamic

java.lang.Object
net.bytebuddy.implementation.InvokeDynamic
All Implemented Interfaces:
InstrumentedType.Prepareable, Implementation, Implementation.Composable
Direct Known Subclasses:
InvokeDynamic.AbstractDelegator
@Enhance public class InvokeDynamic extends Object implements Implementation.Composable
An implementation that applies a dynamic method invocation.

  • Field Details

    • bootstrap

      protected final MethodDescription.InDefinedShape bootstrap
      The bootstrap method.

    • arguments

      protected final List<? extends JavaConstant> arguments
      The arguments that are provided to the bootstrap method.

    • invocationProvider

      protected final InvokeDynamic.InvocationProvider invocationProvider
      The target provided that identifies the method to be bootstrapped.

    • terminationHandler

      protected final InvokeDynamic.TerminationHandler terminationHandler
      A handler that handles the method return.

    • assigner

      protected final Assigner assigner
      The assigner to be used.

    • typing

      protected final Assigner.Typing 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

      public static InvokeDynamic.WithImplicitTarget bootstrap(Method method, Object... constant)
      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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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(Method method, List<?> constants)
      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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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 as TypeDescription, as JavaConstant, as String or a primitive int, long, float or double 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

      public static InvokeDynamic.WithImplicitArguments lambda(Method method, Type 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:
      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

      public InvokeDynamic withBooleanValue(boolean... value)
      Requires the bootstrap method to bootstrap a method that takes the specified boolean 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

      public InvokeDynamic withByteValue(byte... value)
      Requires the bootstrap method to bootstrap a method that takes the specified byte 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

      public InvokeDynamic withShortValue(short... value)
      Requires the bootstrap method to bootstrap a method that takes the specified short 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

      public InvokeDynamic withCharacterValue(char... value)
      Requires the bootstrap method to bootstrap a method that takes the specified char 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

      public InvokeDynamic withIntegerValue(int... value)
      Requires the bootstrap method to bootstrap a method that takes the specified int 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

      public InvokeDynamic withLongValue(long... value)
      Requires the bootstrap method to bootstrap a method that takes the specified long 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

      public InvokeDynamic withFloatValue(float... value)
      Requires the bootstrap method to bootstrap a method that takes the specified float 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

      public InvokeDynamic withDoubleValue(double... value)
      Requires the bootstrap method to bootstrap a method that takes the specified double 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

      public InvokeDynamic withValue(Object... value)

      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

      public InvokeDynamic.WithImplicitType 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.

      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

      public InvokeDynamic withReference(Object... value)
      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

      public InvokeDynamic withType(TypeDescription... typeDescription)
      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

      public InvokeDynamic withEnumeration(EnumerationDescription... enumerationDescription)
      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

      public InvokeDynamic withInstance(ConstantValue... constant)
      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

      public InvokeDynamic withInstance(JavaConstant... constant)
      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

      public InvokeDynamic withNullValue(Class<?>... type)
      Passes null values of the given types to the bootstrapped method.
      Parameters:
      type - The type that the null values should represent.
      Returns:
      This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.

    • withNullValue

      public InvokeDynamic withNullValue(TypeDescription... typeDescription)
      Passes null values of the given types to the bootstrapped method.
      Parameters:
      typeDescription - The type that the null values should represent.
      Returns:
      This invoke dynamic implementation where the bootstrapped method is passed the specified arguments.

    • withArgument

      public InvokeDynamic withArgument(int... index)
      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

      public InvokeDynamic.WithImplicitType withArgument(int index)
      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

      public InvokeDynamic withThis(Class<?>... type)
      Passes references to this onto the operand stack where the instance is represented as the given types.
      Parameters:
      type - The types as which the this reference of the intercepted method should be masked.
      Returns:
      This implementation where this references are passed as the next arguments.

    • withThis

      public InvokeDynamic withThis(TypeDescription... typeDescription)
      Passes references to this onto the operand stack where the instance is represented as the given types.
      Parameters:
      typeDescription - The types as which the this reference of the intercepted method should be masked.
      Returns:
      This implementation where this references are passed as the next arguments.

    • withMethodArguments

      public InvokeDynamic withMethodArguments()
      Adds all method arguments to the the bootstrapped method.
      Returns:
      This invoke dynamic implementation with all parameters of the instrumented method added.

    • withImplicitAndMethodArguments

      public InvokeDynamic withImplicitAndMethodArguments()
      Adds a potential this 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

      public InvokeDynamic withField(String... name)
      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 withField(FieldLocator.Factory fieldLocatorFactory, String... name)
      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

      public InvokeDynamic.WithImplicitType withField(String name)
      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

      public Implementation.Composable withAssigner(Assigner assigner, Assigner.Typing typing)
      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

      public Implementation andThen(Implementation implementation)
      Appends the supplied implementation to this implementation.
      Specified by:
      andThen in interface Implementation.Composable
      Parameters:
      implementation - The subsequent implementation.
      Returns:
      An implementation that combines this implementation with the provided one.

    • andThen

      public Implementation.Composable andThen(Implementation.Composable implementation)
      Appends the supplied composable implementation to this implementation.
      Specified by:
      andThen in interface Implementation.Composable
      Parameters:
      implementation - The subsequent composable implementation.
      Returns:
      A composable implementation that combines this implementation with the provided one.

    • prepare

      public InstrumentedType prepare(InstrumentedType instrumentedType)
      Prepares a given instrumented type.
      Specified by:
      prepare in interface InstrumentedType.Prepareable
      Parameters:
      instrumentedType - The instrumented type in its current form.
      Returns:
      The prepared instrumented type.

    • appender

      public ByteCodeAppender appender(Implementation.Target implementationTarget)
      Creates a byte code appender that determines the implementation of the instrumented type's methods.
      Specified by:
      appender in interface Implementation
      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).