net.bytebuddy.instrumentation

Interface Instrumentation.Context

All Known Subinterfaces:

Instrumentation.Context.ExtractableView

All Known Implementing Classes:

Instrumentation.Context.Default

Enclosing interface:

Instrumentation

public static interface Instrumentation.Context

The context for an instrumentation application. An instrumentation context represents a mutable data structure and all queries are irrevocable. Calling methods on an instrumentation context should be considered equally sensitive as calling a MethodVisitor. As such, an instrumentation context and a MethodVisitor are complementary for creating an new Java type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Instrumentation.Context.Default A default implementation of an Instrumentation.Context.ExtractableView which serves as its own AuxiliaryType.MethodAccessorFactory.
static interface	Instrumentation.Context.ExtractableView Represents an extractable view of an Instrumentation.Context which allows the retrieval of any registered auxiliary type.

Method Summary

Modifier and Type	Method and Description
FieldDescription	cache(StackManipulation fieldValue, TypeDescription fieldType) Caches a single value by storing it in form of a private, final and static field.
TypeDescription	register(AuxiliaryType auxiliaryType) Registers an auxiliary type as required for the current instrumentation.

Method Detail

register

TypeDescription register(AuxiliaryType auxiliaryType)

Registers an auxiliary type as required for the current instrumentation. Registering a type will cause the creation of this type even if this type is not effectively used for the current instrumentation.

Parameters:

auxiliaryType - The auxiliary type that is required for the current instrumentation.

Returns:

A description of the registered auxiliary type.

cache

FieldDescription cache(StackManipulation fieldValue,
                       TypeDescription fieldType)

Caches a single value by storing it in form of a private, final and static field. By caching values, expensive instance creations can be avoided and object identity can be preserved. The field is initiated in a generated class's static initializer.

Parameters:

fieldValue - A stack manipulation for creating the value that is to be cached in a static field. After executing the stack manipulation, exactly one value must be put onto the operand stack which is assignable to the given fieldType.

fieldType - The type of the field for storing the cached value. This field's type determines the value that is put onto the operand stack by this method's returned stack manipulation.

Returns:

A description of a field that was defined on the instrumented type which contains the given value.