net.bytebuddy.agent.builder

Enum AgentBuilder.InitializationStrategy.SelfInjection

java.lang.Object

java.lang.Enum<AgentBuilder.InitializationStrategy.SelfInjection>

net.bytebuddy.agent.builder.AgentBuilder.InitializationStrategy.SelfInjection

All Implemented Interfaces:

Serializable, Comparable<AgentBuilder.InitializationStrategy.SelfInjection>, AgentBuilder.InitializationStrategy, ByteCodeAppender, Implementation

Enclosing interface:

AgentBuilder.InitializationStrategy

public static enum AgentBuilder.InitializationStrategy.SelfInjection
extends Enum<AgentBuilder.InitializationStrategy.SelfInjection>
implements AgentBuilder.InitializationStrategy, Implementation, ByteCodeAppender

An initialization strategy that adds a code block to an instrumented type's type initializer which then calls a specific class that is responsible for the explicit initialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentBuilder.InitializationStrategy.SelfInjection.Nexus This nexus is a global dispatcher for initializing classes with LoadedTypeInitializers.

Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder.InitializationStrategy

AgentBuilder.InitializationStrategy.NoOp, AgentBuilder.InitializationStrategy.SelfInjection

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

Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.bytecode.ByteCodeAppender

ByteCodeAppender.Compound, ByteCodeAppender.Simple, ByteCodeAppender.Size

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
ByteCodeAppender	appender(Implementation.Target implementationTarget) Creates a byte code appender that determines the implementation of the instrumented type's methods.
DynamicType.Builder<?>	apply(DynamicType.Builder<?> builder) Transforms the instrumented type to implement an appropriate initialization strategy.
ByteCodeAppender.Size	apply(MethodVisitor methodVisitor, Implementation.Context implementationContext, MethodDescription instrumentedMethod) Applies this byte code appender to a type creation process.
void	initialize(Class<?> type, LoadedTypeInitializer loadedTypeInitializer) Determines if and how a loaded type initializer is to be applied to a loaded type.
InstrumentedType	prepare(InstrumentedType instrumentedType) During the preparation phase of an implementation, implementations are eligible to adding fields or methods to the currently instrumented type.
void	register(String name, ClassLoader classLoader, LoadedTypeInitializer loadedTypeInitializer) Registers a loaded type initializer for a type name and class loader pair.
String	toString()
static AgentBuilder.InitializationStrategy.SelfInjection	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentBuilder.InitializationStrategy.SelfInjection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final AgentBuilder.InitializationStrategy.SelfInjection INSTANCE

The singleton instance.

Method Detail

values

public static AgentBuilder.InitializationStrategy.SelfInjection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AgentBuilder.InitializationStrategy.SelfInjection c : AgentBuilder.InitializationStrategy.SelfInjection.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AgentBuilder.InitializationStrategy.SelfInjection valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

apply

public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder)

Description copied from interface: AgentBuilder.InitializationStrategy

Transforms the instrumented type to implement an appropriate initialization strategy.

Specified by:

apply in interface AgentBuilder.InitializationStrategy

Parameters:

builder - The builder which should implement the initialization strategy.

Returns:

The given builder with the initialization strategy applied.

initialize

public void initialize(Class<?> type,
                       LoadedTypeInitializer loadedTypeInitializer)

Description copied from interface: AgentBuilder.InitializationStrategy

Determines if and how a loaded type initializer is to be applied to a loaded type.

Specified by:

initialize in interface AgentBuilder.InitializationStrategy

Parameters:

type - The loaded type.

loadedTypeInitializer - The type's loaded type initializer.

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).

apply

public ByteCodeAppender.Size apply(MethodVisitor methodVisitor,
                                   Implementation.Context implementationContext,
                                   MethodDescription instrumentedMethod)

Description copied from interface: ByteCodeAppender

Applies this byte code appender to a type creation process.

Specified by:

apply in interface ByteCodeAppender

Parameters:

methodVisitor - The method visitor to which the byte code appender writes its code to.

implementationContext - The implementation context of the current type creation process.

instrumentedMethod - The method that is the target of the instrumentation.

Returns:

The required size for the applied byte code to run.

register

public void register(String name,
                     ClassLoader classLoader,
                     LoadedTypeInitializer loadedTypeInitializer)

Description copied from interface: AgentBuilder.InitializationStrategy

Registers a loaded type initializer for a type name and class loader pair.

Specified by:

register in interface AgentBuilder.InitializationStrategy

Parameters:

name - The name of the type for which the loaded type initializer is to be registered.

classLoader - The class loader of the instrumented type. Might be null if this class loader represents the bootstrap class loader.

loadedTypeInitializer - The loaded type initializer that is being registered.

toString

public String toString()

Overrides:

toString in class Enum<AgentBuilder.InitializationStrategy.SelfInjection>