Forwarding (Byte Buddy (with dependencies) 1.5.2 API)

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

All Implemented Interfaces:

InstrumentedType.Prepareable, Implementation, Implementation.Composable
```
public class Forwarding
extends Object
implements Implementation.Composable
```
This implementation 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.

See Also:

MethodDelegation

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Forwarding.Appender` An appender for implementing a `Forwarding` operation.
`protected static interface`	`Forwarding.PreparationHandler` A preparation handler is responsible for reading the field containing the forwarding instance.
`protected static class`	`Forwarding.TerminationHandler` A termination handler is responsible for a method's return.

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 Forwarding.PreparationHandler`	`preparationHandler` A handler for preparing the instrumented type and the field invocation operation.
`protected Forwarding.TerminationHandler`	`terminationHandler` The termination handler to apply.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Forwarding(Forwarding.PreparationHandler preparationHandler, Forwarding.TerminationHandler terminationHandler)` Creates a new forwarding 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.
`boolean`	`equals(Object object)`
`int`	`hashCode()`
`InstrumentedType`	`prepare(InstrumentedType instrumentedType)` Prepares a given instrumented type.
`static Implementation.Composable`	`to(Object delegate)` Forwards all intercepted method invocations to the given instance which is stored in a `static` field of the instrumented class.
`static Implementation.Composable`	`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 Implementation.Composable`	`to(Object delegate, String fieldName, Type type)` Forwards all intercepted method invocations to the given instance which is stored in a `static` field of the instrumented class.
`static Implementation.Composable`	`to(Object delegate, Type type)` Forwards all intercepted method invocations to the given instance which is stored in a `static` field of the instrumented class.
`static Implementation.Composable`	`toField(String name)` Delegates a method invocation to a field.
`static Implementation.Composable`	`toField(String name, FieldLocator.Factory fieldLocatorFactory)` Delegates a method invocation to a field.
`String`	`toString()`

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

- Field Detail
  - preparationHandler
```
protected final Forwarding.PreparationHandler preparationHandler
```
    A handler for preparing the instrumented type and the field invocation operation.
  - terminationHandler
```
protected final Forwarding.TerminationHandler terminationHandler
```
    The termination handler to apply.
- Constructor Detail
  - Forwarding
```
protected Forwarding(Forwarding.PreparationHandler preparationHandler,
                     Forwarding.TerminationHandler terminationHandler)
```
    Creates a new forwarding implementation.
    
    Parameters:
    
    preparationHandler - A handler for preparing the instrumented type and the field invocation operation.
    
    terminationHandler - The termination handler to apply.
- Method Detail
  - to
```
public static Implementation.Composable 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 implementation.
  - to
```
public static Implementation.Composable 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 implementation.
  - to
```
public static Implementation.Composable to(Object delegate,
                                           Type type)
```
    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.
    
    type - The type of the field. Must be a subtype of the delegate's type.
    
    Returns:
    
    A corresponding implementation.
  - to
```
public static Implementation.Composable to(Object delegate,
                                           String fieldName,
                                           Type type)
```
    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.
    
    type - The type of the field. Must be a subtype of the delegate's type.
    
    Returns:
    
    A corresponding implementation.
  - toField
```
public static Implementation.Composable toField(String name)
```
    Delegates a method invocation to a field. The field's type must be compatible to the declaring type of the method.
    
    Parameters:
    
    name - The name of the field.
    
    Returns:
    
    An implementation for a method forwarding that invokes the instrumented method on the given field.
  - toField
```
public static Implementation.Composable toField(String name,
                                                FieldLocator.Factory fieldLocatorFactory)
```
    Delegates a method invocation to a field. The field's type must be compatible to the declaring type of the method.
    
    Parameters:
    
    name - The name of the field.
    
    fieldLocatorFactory - The field locator factory to use.
    
    Returns:
    
    An implementation for a method forwarding that invokes the instrumented method on the given field.
  - 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 InstrumentedType.Prepareable.prepare(InstrumentedType).
  - 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: InstrumentedType.Prepareable
    
    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.
  - equals
```
public boolean equals(Object object)
```
    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.implementation.Implementation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

preparationHandler

terminationHandler

Constructor Detail

Forwarding

Method Detail

to

to

to

to

toField

toField

appender

andThen

prepare

equals

hashCode

toString