Forwarding (Byte Buddy (with dependencies) 0.5 API)

java.lang.Object
- net.bytebuddy.instrumentation.Forwarding

All Implemented Interfaces:

Instrumentation
```
public class Forwarding
extends Object
implements Instrumentation
```
This instrumentation forwards method invocations to another instance. For this, the intercepted method must be defined on a super type of the given delegation target. Static methods cannot be forwarded as they are not invoked on an instance.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Forwarding.Appender` An appender for implementing a `Forwarding` operation.
`protected static interface`	`Forwarding.PreparationHandler` A handler for preparing a `Forwarding` instrumentation.

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.Instrumentation
Instrumentation.Compound, Instrumentation.Context, Instrumentation.ForAbstractMethod, Instrumentation.Simple, Instrumentation.SpecialMethodInvocation, Instrumentation.Target

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`fieldName` The name of the field.
`protected TypeDescription`	`fieldType` The type of the field.
`protected Forwarding.PreparationHandler`	`preparationHandler` A handler for preparing the instrumented type and the field invocation operation.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Forwarding(String fieldName, TypeDescription fieldType, Forwarding.PreparationHandler preparationHandler)` Creates a new forwarding instrumentation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteCodeAppender`	`appender(Instrumentation.Target instrumentationTarget)` Creates a byte code appender that determines the implementation of the instrumented type's methods.
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`InstrumentedType`	`prepare(InstrumentedType instrumentedType)` During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type.
`static Instrumentation`	`to(Object delegate)` Forwards all intercepted method invocations to the given instance which is stored in a `static` field of the instrumented class.
`static Instrumentation`	`to(Object delegate, String fieldName)` Forwards all intercepted method invocations to the given instance which is stored in a `static` field of the instrumented class.
`static Instrumentation`	`toInstanceField(String fieldName, Class<?> fieldType)` Forwards all intercepted method invocations to an instance field of the instrumented class.
`static Instrumentation`	`toInstanceField(String fieldName, TypeDescription fieldType)` Forwards all intercepted method invocations to an instance field of the instrumented class.
`static Instrumentation`	`toStaticField(String fieldName, Class<?> fieldType)` Forwards all intercepted method invocations to a `static` field of the instrumented class.
`static Instrumentation`	`toStaticField(String fieldName, TypeDescription fieldType)` Forwards all intercepted method invocations to a `static` field of the instrumented class.
`String`	`toString()`

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

- Field Detail
  - fieldName
```
protected final String fieldName
```
    The name of the field.
  - fieldType
```
protected final TypeDescription fieldType
```
    The type of the field.
  - preparationHandler
```
protected final Forwarding.PreparationHandler preparationHandler
```
    A handler for preparing the instrumented type and the field invocation operation.
- Constructor Detail
  - Forwarding
```
protected Forwarding(String fieldName,
                     TypeDescription fieldType,
                     Forwarding.PreparationHandler preparationHandler)
```
    Creates a new forwarding instrumentation.
    
    Parameters:
    
    fieldName - The name of the field.
    
    fieldType - The type of the field.
    
    preparationHandler - A handler for preparing the instrumented type and the field invocation operation.
- Method Detail
  - to
```
public static Instrumentation to(Object delegate)
```
    Forwards all intercepted method invocations to the given instance which is stored in a static field of the instrumented class. The field name is generated from the instance's hash code.
    
    Parameters:
    
    delegate - The delegate to which all intercepted methods should be forwarded.
    
    Returns:
    
    A corresponding instrumentation.
  - to
```
public static Instrumentation to(Object delegate,
                                 String fieldName)
```
    Forwards all intercepted method invocations to the given instance which is stored in a static field of the instrumented class.
    
    Parameters:
    
    delegate - The delegate to which all intercepted methods should be forwarded.
    
    fieldName - The name of the field in which the delegate should be stored.
    
    Returns:
    
    A corresponding instrumentation.
  - toStaticField
```
public static Instrumentation toStaticField(String fieldName,
                                            Class<?> fieldType)
```
    Forwards all intercepted method invocations to a static field of the instrumented class. The value of this field must be set explicitly.
    
    Parameters:
    
    fieldName - The name of the field in which the delegate should be stored.
    
    fieldType - The type of the field and thus the type of which the delegate is assumed to be of.
    
    Returns:
    
    A corresponding instrumentation.
  - toStaticField
```
public static Instrumentation toStaticField(String fieldName,
                                            TypeDescription fieldType)
```
    Forwards all intercepted method invocations to a static field of the instrumented class. The value of this field must be set explicitly.
    
    Parameters:
    
    fieldName - The name of the field in which the delegate should be stored.
    
    fieldType - The type of the field and thus the type of which the delegate is assumed to be of.
    
    Returns:
    
    A corresponding instrumentation.
  - toInstanceField
```
public static Instrumentation toInstanceField(String fieldName,
                                              Class<?> fieldType)
```
    Forwards all intercepted method invocations to an instance field of the instrumented class. The value of this field must be set explicitly.
    
    Parameters:
    
    fieldName - The name of the field in which the delegate should be stored.
    
    fieldType - The type of the field and thus the type of which the delegate is assumed to be of.
    
    Returns:
    
    A corresponding instrumentation.
  - toInstanceField
```
public static Instrumentation toInstanceField(String fieldName,
                                              TypeDescription fieldType)
```
    Forwards all intercepted method invocations to an instance field of the instrumented class. The value of this field must be set explicitly.
    
    Parameters:
    
    fieldName - The name of the field in which the delegate should be stored.
    
    fieldType - The type of the field and thus the type of which the delegate is assumed to be of.
    
    Returns:
    
    A corresponding instrumentation.
  - appender
```
public ByteCodeAppender appender(Instrumentation.Target instrumentationTarget)
```
    Description copied from interface: Instrumentation
    
    Creates a byte code appender that determines the implementation of the instrumented type's methods.
    
    Specified by:
    
    appender in interface Instrumentation
    
    Parameters:
    
    instrumentationTarget - The target of the current instrumentation.
    
    Returns:
    
    A byte code appender for implementing methods delegated to this instrumentation. This byte code appender is also responsible for handling methods that were added by this instrumentation on the call to Instrumentation.prepare(net.bytebuddy.instrumentation.type.InstrumentedType).
  - prepare
```
public InstrumentedType prepare(InstrumentedType instrumentedType)
```
    Description copied from interface: Instrumentation
    
    During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type. All methods that are added by this instrumentation are required to be implemented by the ByteCodeAppender that is emitted on the call to Instrumentation.appender(net.bytebuddy.instrumentation.Instrumentation.Target) call. On this method call, loaded type initializers can also be added to the instrumented type.
    
    Specified by:
    
    prepare in interface Instrumentation
    
    Parameters:
    
    instrumentedType - The instrumented type that is the basis of the ongoing instrumentation.
    
    Returns:
    
    The instrumented type with any applied changes, if any.
  - 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 Forwarding

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.Instrumentation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fieldName

fieldType

preparationHandler

Constructor Detail

Forwarding

Method Detail

to

to

toStaticField

toStaticField

toInstanceField

toInstanceField

appender

prepare

equals

hashCode

toString