net.bytebuddy.instrumentation

Class Instrumentation.Context.Default

java.lang.Object

net.bytebuddy.instrumentation.Instrumentation.Context.Default

All Implemented Interfaces:

Instrumentation.Context, Instrumentation.Context.ExtractableView, AuxiliaryType.MethodAccessorFactory

Enclosing interface:

Instrumentation.Context

public static class Instrumentation.Context.Default
extends Object
implements Instrumentation.Context.ExtractableView, AuxiliaryType.MethodAccessorFactory

A default implementation of an Instrumentation.Context.ExtractableView which serves as its own AuxiliaryType.MethodAccessorFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Instrumentation.Context.Default.AccessorMethodDelegation An implementation of a TypeWriter.MethodPool.Entry for implementing an accessor method.
static interface	Instrumentation.Context.Default.AuxiliaryTypeNamingStrategy Representation of a naming strategy for an auxiliary type.
protected static class	Instrumentation.Context.Default.FieldCacheAppender A byte code appender that writes the field cache entries to a given MethodVisitor.
protected static class	Instrumentation.Context.Default.FieldCacheEntry A field cache entry for uniquely identifying a cached field.
protected static class	Instrumentation.Context.Default.FieldGetter An implementation for a field getter.
protected static class	Instrumentation.Context.Default.FieldSetter An implementation for a field setter.

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

Instrumentation.Context.ExtractableView.InjectedCode

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

Instrumentation.Context.Default, Instrumentation.Context.ExtractableView

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.type.auxiliary.AuxiliaryType.MethodAccessorFactory

AuxiliaryType.MethodAccessorFactory.Illegal

Field Summary

Fields inherited from interface net.bytebuddy.instrumentation.Instrumentation.Context.ExtractableView

FIELD_CACHE_MODIFIER

Fields inherited from interface net.bytebuddy.instrumentation.type.auxiliary.AuxiliaryType.MethodAccessorFactory

ACCESSOR_METHOD_MODIFIER

Constructor Summary

Constructors

Constructor and Description
Default(TypeDescription instrumentedType, InstrumentedType.TypeInitializer typeInitializer, ClassFileVersion classFileVersion) Creates a new delegate.
Default(TypeDescription instrumentedType, InstrumentedType.TypeInitializer typeInitializer, ClassFileVersion classFileVersion, String accessorMethodSuffix, String fieldCachePrefix, Instrumentation.Context.Default.AuxiliaryTypeNamingStrategy auxiliaryTypeNamingStrategy) Creates a new delegate.

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.
void	drain(org.objectweb.asm.ClassVisitor classVisitor, TypeWriter.MethodPool methodPool, Instrumentation.Context.ExtractableView.InjectedCode injectedCode) Writes any information that was registered with an Instrumentation.Context to the provided class visitor.
List<DynamicType>	getRegisteredAuxiliaryTypes() Returns any AuxiliaryType that was registered with this Instrumentation.Context.
TypeDescription	register(AuxiliaryType auxiliaryType) Registers an auxiliary type as required for the current instrumentation.
MethodDescription	registerAccessorFor(Instrumentation.SpecialMethodInvocation specialMethodInvocation) Registers an accessor method for a Instrumentation.SpecialMethodInvocation which cannot itself be triggered invoked directly from outside a type.
MethodDescription	registerGetterFor(FieldDescription fieldDescription) Registers a getter for the given FieldDescription which might itself not be accessible from outside the class.
MethodDescription	registerSetterFor(FieldDescription fieldDescription) Registers a setter for the given FieldDescription which might itself not be accessible from outside the class.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Default

public Default(TypeDescription instrumentedType,
               InstrumentedType.TypeInitializer typeInitializer,
               ClassFileVersion classFileVersion)

Creates a new delegate. This constructor implicitly defines default naming strategies for created accessor method and registered auxiliary types.

Parameters:

instrumentedType - The description of the type that is currently subject of creation.

typeInitializer - The type initializer of the created instrumented type.

classFileVersion - The class file version of the created class.

Default

public Default(TypeDescription instrumentedType,
               InstrumentedType.TypeInitializer typeInitializer,
               ClassFileVersion classFileVersion,
               String accessorMethodSuffix,
               String fieldCachePrefix,
               Instrumentation.Context.Default.AuxiliaryTypeNamingStrategy auxiliaryTypeNamingStrategy)

Creates a new delegate.

Parameters:

instrumentedType - The description of the type that is currently subject of creation.

typeInitializer - The type initializer of the created instrumented type.

classFileVersion - The class file version of the created class.

accessorMethodSuffix - A suffix that is added to any accessor method where the method name is prefixed by the accessed method's name.

fieldCachePrefix - A prefix that is added to any field cache.

auxiliaryTypeNamingStrategy - The naming strategy for naming an auxiliary type.

Method Detail

registerAccessorFor

public MethodDescription registerAccessorFor(Instrumentation.SpecialMethodInvocation specialMethodInvocation)

Description copied from interface: AuxiliaryType.MethodAccessorFactory

Registers an accessor method for a Instrumentation.SpecialMethodInvocation which cannot itself be triggered invoked directly from outside a type. The method is registered on the instrumented type with package-private visibility, similarly to a Java compiler's accessor methods.

Specified by:

registerAccessorFor in interface AuxiliaryType.MethodAccessorFactory

Parameters:

specialMethodInvocation - The special method invocation.

Returns:

The accessor method for invoking the special method invocation.

registerGetterFor

public MethodDescription registerGetterFor(FieldDescription fieldDescription)

Description copied from interface: AuxiliaryType.MethodAccessorFactory

Registers a getter for the given FieldDescription which might itself not be accessible from outside the class. The returned getter method defines the field type as its return type, does not take any arguments and is of package-private visibility, similarly to the Java compiler's accessor methods. If the field is static, this accessor method is also static.

Specified by:

registerGetterFor in interface AuxiliaryType.MethodAccessorFactory

Parameters:

fieldDescription - The field which is to be accessed.

Returns:

A getter method for the given field.

registerSetterFor

public MethodDescription registerSetterFor(FieldDescription fieldDescription)

Description copied from interface: AuxiliaryType.MethodAccessorFactory

Registers a setter for the given FieldDescription which might itself not be accessible from outside the class. The returned setter method defines the field type as its only argument type, returns void and is of package-private visibility, similarly to the Java compiler's accessor methods. If the field is static, this accessor method is also static.

Specified by:

registerSetterFor in interface AuxiliaryType.MethodAccessorFactory

Parameters:

fieldDescription - The field which is to be accessed.

Returns:

A setter method for the given field.

register

public TypeDescription register(AuxiliaryType auxiliaryType)

Description copied from interface: Instrumentation.Context

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.

Specified by:

register in interface Instrumentation.Context

Parameters:

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

Returns:

A description of the registered auxiliary type.

getRegisteredAuxiliaryTypes

public List<DynamicType> getRegisteredAuxiliaryTypes()

Description copied from interface: Instrumentation.Context.ExtractableView

Returns any AuxiliaryType that was registered with this Instrumentation.Context.

Specified by:

getRegisteredAuxiliaryTypes in interface Instrumentation.Context.ExtractableView

Returns:

A list of all manifested registered auxiliary types.

cache

public FieldDescription cache(StackManipulation fieldValue,
                              TypeDescription fieldType)

Description copied from interface: Instrumentation.Context

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.

Specified by:

cache in interface Instrumentation.Context

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.

drain

public void drain(org.objectweb.asm.ClassVisitor classVisitor,
                  TypeWriter.MethodPool methodPool,
                  Instrumentation.Context.ExtractableView.InjectedCode injectedCode)

Description copied from interface: Instrumentation.Context.ExtractableView

Writes any information that was registered with an Instrumentation.Context to the provided class visitor. This contains any fields for value caching, any accessor method and it writes the type initializer. The type initializer must therefore never be written manually.

Specified by:

drain in interface Instrumentation.Context.ExtractableView

Parameters:

classVisitor - The class visitor to which the extractable view is to be written.

methodPool - A method pool which is queried for any user code to add to the type initializer.

injectedCode - Potential code that is to be injected into the type initializer.

toString

public String toString()

Overrides:

toString in class Object