net.bytebuddy.agent.builder

Enum AgentBuilder.DescriptionStrategy

java.lang.Object

java.lang.Enum<AgentBuilder.DescriptionStrategy>

net.bytebuddy.agent.builder.AgentBuilder.DescriptionStrategy

All Implemented Interfaces:

Serializable, Comparable<AgentBuilder.DescriptionStrategy>

Enclosing interface:

AgentBuilder

public static enum AgentBuilder.DescriptionStrategy
extends Enum<AgentBuilder.DescriptionStrategy>

A description strategy is responsible for resolving a TypeDescription when transforming or retransforming/-defining a type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HYBRID A description type strategy represents a type as a TypeDescription.ForLoadedType if a retransformation or redefinition is applied on a type.
POOL_ONLY A description strategy that always describes Java types using a TypePool.

Method Summary

Modifier and Type	Method and Description
protected abstract TypeDescription	apply(Class<?> type, AgentBuilder.TypeLocator typeLocator) Describes the given type.
protected abstract TypeDescription	apply(String typeName, Class<?> typeBeingRedefined, AgentBuilder.TypeLocator typeLocator, ClassLoader classLoader, ClassFileLocator classFileLocator) Describes the given type.
String	toString()
static AgentBuilder.DescriptionStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentBuilder.DescriptionStrategy[]	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

HYBRID

public static final AgentBuilder.DescriptionStrategy HYBRID

A description type strategy represents a type as a TypeDescription.ForLoadedType if a retransformation or redefinition is applied on a type. Using a loaded type typically results in better performance as no I/O is required for resolving type descriptions. However, any interaction with the type is carried out via the Java reflection API. Using the reflection API triggers eager loading of any type that is part of a method or field signature. If any of these types are missing from the class path, this eager loading will cause a NoClassDefFoundError. Some Java code declares optional dependencies to other classes which are only realized if the optional dependency is present. Such code relies on the Java reflection API not being used for types using optional dependencies.

POOL_ONLY

public static final AgentBuilder.DescriptionStrategy POOL_ONLY

A description strategy that always describes Java types using a TypePool. This requires that any type - even if it is already loaded and a Class instance is available - is processed as a non-loaded type description. Doing so can cause overhead as processing loaded types is supported very efficiently by a JVM.

Avoiding the usage of loaded types can improve robustness as this approach does not rely on the Java reflection API which triggers eager validation of this loaded type which can fail an application if optional types are used by any types field or method signatures. Also, it is possible to guarantee debugging meta data to be available also for retransformed or redefined types if a AgentBuilder.TypeStrategy specifies the extraction of such meta data.

Method Detail

values

public static AgentBuilder.DescriptionStrategy[] 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.DescriptionStrategy c : AgentBuilder.DescriptionStrategy.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.DescriptionStrategy 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

protected abstract TypeDescription apply(String typeName,
                                         Class<?> typeBeingRedefined,
                                         AgentBuilder.TypeLocator typeLocator,
                                         ClassLoader classLoader,
                                         ClassFileLocator classFileLocator)

Describes the given type.

Parameters:

typeName - The binary name of the type to describe.

typeBeingRedefined - The type that is being redefined, if a redefinition is applied or null if no redefined type is available.

typeLocator - The type locator to use.

classLoader - The class loader of the type to be described.

classFileLocator - The class file locator of the type to be described.

Returns:

An appropriate type description.

apply

protected abstract TypeDescription apply(Class<?> type,
                                         AgentBuilder.TypeLocator typeLocator)

Describes the given type.

Parameters:

type - The loaded type to be described.

typeLocator - The type locator to use.

Returns:

An appropriate type description.

toString

public String toString()

Overrides:

toString in class Enum<AgentBuilder.DescriptionStrategy>