MethodCall (Byte Buddy (without dependencies) 0.7.2 API)

java.lang.Object
- net.bytebuddy.implementation.MethodCall

All Implemented Interfaces:

Implementation, Implementation.Composable

Direct Known Subclasses:

MethodCall.WithoutSpecifiedTarget
```
public class MethodCall
extends Object
implements Implementation.Composable
```
This Implementation allows the invocation of a specified method while providing explicit arguments to this method.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`MethodCall.Appender` The appender being used to implement a `MethodCall`.
`protected static interface`	`MethodCall.ArgumentLoader` An argument loader is responsible for loading an argument for an invoked method onto the operand stack.
`protected static interface`	`MethodCall.MethodInvoker` A method invoker is responsible for creating a method invocation that is to be applied by a `MethodCall`.
`static interface`	`MethodCall.MethodLocator` A method locator is responsible for identifying the method that is to be invoked by a `MethodCall`.
`protected static interface`	`MethodCall.TargetHandler` A target handler is responsible for invoking a method for a `MethodCall`.
`protected static interface`	`MethodCall.TerminationHandler` A termination handler is responsible to handle the return value of a method that is invoked via a `MethodCall`.
`static class`	`MethodCall.WithoutSpecifiedTarget` Represents a `MethodCall` that invokes a method without specifying an invocation method.

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation
Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<MethodCall.ArgumentLoader>`	`argumentLoaders` The argument loader to load arguments onto the operand stack in their application order.
`protected Assigner`	`assigner` The assigner to use.
`protected MethodCall.MethodInvoker`	`methodInvoker` The method invoker to use.
`protected MethodCall.MethodLocator`	`methodLocator` The method locator to use.
`protected MethodCall.TargetHandler`	`targetHandler` The target handler to use.
`protected MethodCall.TerminationHandler`	`terminationHandler` The termination handler to use.
`protected Assigner.Typing`	`typing` Indicates if dynamic type castings should be attempted for incompatible assignments.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MethodCall(MethodCall.MethodLocator methodLocator, MethodCall.TargetHandler targetHandler, List<MethodCall.ArgumentLoader> argumentLoaders, MethodCall.MethodInvoker methodInvoker, MethodCall.TerminationHandler terminationHandler, Assigner assigner, Assigner.Typing typing)` Creates a new method call implementation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Implementation`	`andThen(Implementation implementation)` Appends the supplied implementation to this implementation.
`ByteCodeAppender`	`appender(Implementation.Target implementationTarget)` Creates a byte code appender that determines the implementation of the instrumented type's methods.
`static MethodCall`	`construct(Constructor<?> constructor)` Invokes the given constructor in order to create an instance.
`static MethodCall`	`construct(MethodDescription methodDescription)` Invokes the given constructor in order to create an instance.
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`static MethodCall.WithoutSpecifiedTarget`	`invoke(Constructor<?> constructor)` Invokes the given constructor on the instance of the instrumented type.
`static MethodCall.WithoutSpecifiedTarget`	`invoke(Method method)` Invokes the given method.
`static MethodCall.WithoutSpecifiedTarget`	`invoke(MethodCall.MethodLocator methodLocator)` Invokes a method using the provided method locator.
`static MethodCall.WithoutSpecifiedTarget`	`invoke(MethodDescription methodDescription)` Invokes the given method.
`static MethodCall`	`invokeSuper()` Invokes the method that is instrumented by the returned instance by a super method invocation.
`InstrumentedType`	`prepare(InstrumentedType instrumentedType)` During the preparation phase of an implementation, implementations are eligible to adding fields or methods to the currently instrumented type.
`String`	`toString()`
`MethodCall`	`with(EnumerationDescription... enumerationDescription)` Defines the given enumeration values to be provided as arguments to the invoked method where the values are read from the enumeration class on demand.
`MethodCall`	`with(JavaInstance... javaInstance)` Defines the given Java instances to be provided as arguments to the invoked method where the given instances are stored in the generated class's constant pool.
`MethodCall`	`with(Object... argument)` Defines a number of arguments to be handed to the method that is being invoked by this implementation.
`MethodCall`	`with(TypeDescription... typeDescription)` Defines the given types to be provided as arguments to the invoked method where the represented types are stored in the generated class's constant pool.
`MethodCall`	`withArgument(int... index)` Defines a number of arguments of the instrumented method by their parameter indices to be handed to the invoked method as an argument.
`MethodCall`	`withAssigner(Assigner assigner, Assigner.Typing typing)` Defines an assigner to be used for assigning values to the parameters of the invoked method.
`MethodCall`	`withField(String... fieldName)` Defines a method call which fetches a value from an existing field.
`MethodCall`	`withInstanceField(Class<?> type, String name)` Defines a method call which fetches a value from an instance field.
`MethodCall`	`withInstanceField(TypeDescription typeDescription, String name)` Defines a method call which fetches a value from an instance field.
`MethodCall`	`withOwnType()` Assigns the `Class` value of the instrumented type.
`MethodCall`	`withReference(Object... argument)` Defines a number of arguments to be handed to the method that is being invoked by this implementation.
`MethodCall`	`withThis()` Assigns the `this` reference to the next parameter.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - methodLocator
```
protected final MethodCall.MethodLocator methodLocator
```
    The method locator to use.
  - targetHandler
```
protected final MethodCall.TargetHandler targetHandler
```
    The target handler to use.
  - argumentLoaders
```
protected final List<MethodCall.ArgumentLoader> argumentLoaders
```
    The argument loader to load arguments onto the operand stack in their application order.
  - methodInvoker
```
protected final MethodCall.MethodInvoker methodInvoker
```
    The method invoker to use.
  - terminationHandler
```
protected final MethodCall.TerminationHandler terminationHandler
```
    The termination handler to use.
  - assigner
```
protected final Assigner assigner
```
    The assigner to use.
  - typing
```
protected final Assigner.Typing typing
```
    Indicates if dynamic type castings should be attempted for incompatible assignments.
- Constructor Detail
  - MethodCall
```
protected MethodCall(MethodCall.MethodLocator methodLocator,
                     MethodCall.TargetHandler targetHandler,
                     List<MethodCall.ArgumentLoader> argumentLoaders,
                     MethodCall.MethodInvoker methodInvoker,
                     MethodCall.TerminationHandler terminationHandler,
                     Assigner assigner,
                     Assigner.Typing typing)
```
    Creates a new method call implementation.
    
    Parameters:
    
    methodLocator - The method locator to use.
    
    targetHandler - The target handler to use.
    
    argumentLoaders - The argument loader to load arguments onto the operand stack in their application order.
    
    methodInvoker - The method invoker to use.
    
    terminationHandler - The termination handler to use.
    
    assigner - The assigner to use.
    
    typing - Indicates if dynamic type castings should be attempted for incompatible assignments.
- Method Detail
  - invoke
```
public static MethodCall.WithoutSpecifiedTarget invoke(Method method)
```
    Invokes the given method. Without further specification, the method is invoked without any arguments on the instance of the instrumented class or statically, if the given method is static.
    
    Parameters:
    
    method - The method to invoke.
    
    Returns:
    
    A method call implementation that invokes the given method without providing any arguments.
  - invoke
```
public static MethodCall.WithoutSpecifiedTarget invoke(Constructor<?> constructor)
```
    Invokes the given constructor on the instance of the instrumented type.
    
    Parameters:
    
    constructor - The constructor to invoke.
    
    Returns:
    
    A method call implementation that invokes the given constructor without providing any arguments.
  - invoke
```
public static MethodCall.WithoutSpecifiedTarget invoke(MethodDescription methodDescription)
```
    Invokes the given method. If the method description describes a constructor, it is automatically invoked as a special method invocation on the instance of the instrumented type. The same is true for private methods. Finally, static methods are invoked statically.
    
    Parameters:
    
    methodDescription - The method to invoke.
    
    Returns:
    
    A method call implementation that invokes the given method without providing any arguments.
  - invoke
```
public static MethodCall.WithoutSpecifiedTarget invoke(MethodCall.MethodLocator methodLocator)
```
    Invokes a method using the provided method locator.
    
    Parameters:
    
    methodLocator - The method locator to apply for locating the method to invoke given the instrumented method.
    
    Returns:
    
    A method call implementation that uses the provided method locator for resolving the method to be invoked.
  - construct
```
public static MethodCall construct(Constructor<?> constructor)
```
    Invokes the given constructor in order to create an instance.
    
    Parameters:
    
    constructor - The constructor to invoke.
    
    Returns:
    
    A method call that invokes the given constructor without providing any arguments.
  - construct
```
public static MethodCall construct(MethodDescription methodDescription)
```
    Invokes the given constructor in order to create an instance.
    
    Parameters:
    
    methodDescription - A description of the constructor to invoke.
    
    Returns:
    
    A method call that invokes the given constructor without providing any arguments.
  - invokeSuper
```
public static MethodCall invokeSuper()
```
    Invokes the method that is instrumented by the returned instance by a super method invocation.
    
    Returns:
    
    A method call that invokes the method being instrumented.
  - with
```
public MethodCall with(Object... argument)
```
    Defines a number of arguments to be handed to the method that is being invoked by this implementation. Any wrapper type instances for primitive values, instances of String or null are loaded directly onto the operand stack. This might corrupt referential identity for these values. Any other values are stored within a static field that is added to the instrumented type.
    
    Parameters:
    
    argument - The arguments to provide to the method that is being called in their order.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - with
```
public MethodCall with(TypeDescription... typeDescription)
```
    Defines the given types to be provided as arguments to the invoked method where the represented types are stored in the generated class's constant pool.
    
    Parameters:
    
    typeDescription - The type descriptions to provide as arguments.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - with
```
public MethodCall with(EnumerationDescription... enumerationDescription)
```
    Defines the given enumeration values to be provided as arguments to the invoked method where the values are read from the enumeration class on demand.
    
    Parameters:
    
    enumerationDescription - The enumeration descriptions to provide as arguments.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - with
```
public MethodCall with(JavaInstance... javaInstance)
```
    Defines the given Java instances to be provided as arguments to the invoked method where the given instances are stored in the generated class's constant pool.
    
    Parameters:
    
    javaInstance - The Java instances to provide as arguments.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - withReference
```
public MethodCall withReference(Object... argument)
```
    Defines a number of arguments to be handed to the method that is being invoked by this implementation. Any value is stored within a field in order to preserve referential identity. As an exception, the null value is not stored within a field.
    
    Parameters:
    
    argument - The arguments to provide to the method that is being called in their order.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - withArgument
```
public MethodCall withArgument(int... index)
```
    Defines a number of arguments of the instrumented method by their parameter indices to be handed to the invoked method as an argument.
    
    Parameters:
    
    index - The parameter indices of the instrumented method to be handed to the invoked method as an argument in their order. The indices are zero-based.
    
    Returns:
    
    A method call that hands the provided arguments to the invoked method.
  - withThis
```
public MethodCall withThis()
```
    Assigns the this reference to the next parameter.
    
    Returns:
    
    This method call where the next parameter is a assigned a reference to the this reference of the instance of the intercepted method.
  - withOwnType
```
public MethodCall withOwnType()
```
    Assigns the Class value of the instrumented type.
    
    Returns:
    
    This method call where the next parameter is a assigned a reference to the Class value of the instrumented type.
  - withInstanceField
```
public MethodCall withInstanceField(Class<?> type,
                                    String name)
```
    Defines a method call which fetches a value from an instance field. The value of the field needs to be defined manually and is initialized with null. The field itself is defined by this implementation.
    
    Parameters:
    
    type - The type of the field.
    
    name - The name of the field.
    
    Returns:
    
    A method call which assigns the next parameter to the value of the instance field.
  - withInstanceField
```
public MethodCall withInstanceField(TypeDescription typeDescription,
                                    String name)
```
    Defines a method call which fetches a value from an instance field. The value of the field needs to be defined manually and is initialized with null. The field itself is defined by this implementation.
    
    Parameters:
    
    typeDescription - The type of the field.
    
    name - The name of the field.
    
    Returns:
    
    A method call which assigns the next parameter to the value of the instance field.
  - withField
```
public MethodCall withField(String... fieldName)
```
    Defines a method call which fetches a value from an existing field. The field is not defines by this implementation.
    
    Parameters:
    
    fieldName - The name of the field.
    
    Returns:
    
    A method call which assigns the next parameter to the value of the given field.
  - withAssigner
```
public MethodCall withAssigner(Assigner assigner,
                               Assigner.Typing typing)
```
    Defines an assigner to be used for assigning values to the parameters of the invoked method. This assigner is also used for assigning the invoked method's return value to the return type of the instrumented method, if this method is not chained with andThen(Implementation) such that a return value of this method call is discarded.
    
    Parameters:
    
    assigner - The assigner to use.
    
    typing - Indicates if dynamic type castings should be attempted for incompatible assignments.
    
    Returns:
    
    This method call using the provided assigner.
  - andThen
```
public Implementation andThen(Implementation implementation)
```
    Description copied from interface: Implementation.Composable
    
    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.
  - prepare
```
public InstrumentedType prepare(InstrumentedType instrumentedType)
```
    Description copied from interface: Implementation
    
    During the preparation phase of an implementation, implementations are eligible to adding fields or methods to the currently instrumented type. All methods that are added by this implementation are required to be implemented by the ByteCodeAppender that is emitted on the call to Implementation.appender(Implementation.Target) call. On this method call, loaded type initializers can also be added to the instrumented type.
    
    Specified by:
    
    prepare in interface Implementation
    
    Parameters:
    
    instrumentedType - The instrumented type that is the basis of the ongoing instrumentation.
    
    Returns:
    
    The instrumented type with any applied changes, if any.
  - appender
```
public ByteCodeAppender appender(Implementation.Target implementationTarget)
```
    Description copied from interface: Implementation
    
    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 Implementation.prepare(InstrumentedType).
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MethodCall

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

methodLocator

targetHandler

argumentLoaders

methodInvoker

terminationHandler

assigner

typing

Constructor Detail

MethodCall

Method Detail

invoke

invoke

invoke

invoke

construct

construct

invokeSuper

with

with

with

with

withReference

withArgument

withThis

withOwnType

withInstanceField

withInstanceField

withField

withAssigner

andThen

prepare

appender

equals

hashCode

toString