net.bytebuddy.implementation

Class Implementation.Context.Default

java.lang.Object

net.bytebuddy.implementation.Implementation.Context.Default

All Implemented Interfaces:

AuxiliaryType.MethodAccessorFactory, Implementation.Context, Implementation.Context.ExtractableView

Enclosing interface:

Implementation.Context

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Implementation.Context.Default.AbstractDelegationRecord An abstract method pool entry that delegates the implementation of a method to itself.
protected static class	Implementation.Context.Default.AbstractPropertyAccessorMethod A base implementation of a method that accesses a property of an instrumented type.
protected static class	Implementation.Context.Default.AccessorMethod A description of an accessor method to access another method from outside the instrumented type.
protected static class	Implementation.Context.Default.AccessorMethodDelegation An implementation of a TypeWriter.MethodPool.Record for implementing an accessor method.
protected static class	Implementation.Context.Default.CacheValueField A description of a field that stores a cached value.
static class	Implementation.Context.Default.Factory A factory for creating a Implementation.Context.Default.
protected static class	Implementation.Context.Default.FieldCacheEntry A field cache entry for uniquely identifying a cached field.
protected static class	Implementation.Context.Default.FieldGetter A description of a field getter method.
protected static class	Implementation.Context.Default.FieldGetterDelegation An implementation for a field getter.
protected static class	Implementation.Context.Default.FieldSetter A description of a field setter method.
protected static class	Implementation.Context.Default.FieldSetterDelegation An implementation for a field setter.

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

Implementation.Context.ExtractableView.InjectedCode

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

Implementation.Context.Default, Implementation.Context.Disabled, Implementation.Context.ExtractableView

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

AuxiliaryType.MethodAccessorFactory.Illegal

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESSOR_METHOD_SUFFIX The name suffix to be appended to an accessor method.
static String	FIELD_CACHE_PREFIX The name prefix to be prepended to a field storing a cached value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Default(TypeDescription instrumentedType, AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy, InstrumentedType.TypeInitializer typeInitializer, ClassFileVersion classFileVersion) Creates a new default implementation context.

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(ClassVisitor classVisitor, TypeWriter.MethodPool methodPool, Implementation.Context.ExtractableView.InjectedCode injectedCode) Writes any information that was registered with an Implementation.Context to the provided class visitor.
List<DynamicType>	getRegisteredAuxiliaryTypes() Returns any AuxiliaryType that was registered with this Implementation.Context.
boolean	isRetainTypeInitializer() Determines if this implementation context allows for the retention of a static type initializer.
TypeDescription	register(AuxiliaryType auxiliaryType) Registers an auxiliary type as required for the current implementation.
MethodDescription.InDefinedShape	registerAccessorFor(Implementation.SpecialMethodInvocation specialMethodInvocation) Registers an accessor method for a Implementation.SpecialMethodInvocation which cannot itself be triggered invoked directly from outside a type.
MethodDescription.InDefinedShape	registerGetterFor(FieldDescription fieldDescription) Registers a getter for the given FieldDescription which might itself not be accessible from outside the class.
MethodDescription.InDefinedShape	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

Field Detail

ACCESSOR_METHOD_SUFFIX

public static final String ACCESSOR_METHOD_SUFFIX

The name suffix to be appended to an accessor method.

See Also:

Constant Field Values

FIELD_CACHE_PREFIX

public static final String FIELD_CACHE_PREFIX

The name prefix to be prepended to a field storing a cached value.

See Also:

Constant Field Values

Constructor Detail

Default

protected Default(TypeDescription instrumentedType,
                  AuxiliaryType.NamingStrategy auxiliaryTypeNamingStrategy,
                  InstrumentedType.TypeInitializer typeInitializer,
                  ClassFileVersion classFileVersion)

Creates a new default implementation context.

Parameters:

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

auxiliaryTypeNamingStrategy - The naming strategy for naming an auxiliary type.

typeInitializer - The type initializer of the created instrumented type.

classFileVersion - The class file version of the created class.

Method Detail

registerAccessorFor

public MethodDescription.InDefinedShape registerAccessorFor(Implementation.SpecialMethodInvocation specialMethodInvocation)

Description copied from interface: AuxiliaryType.MethodAccessorFactory

Registers an accessor method for a Implementation.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.InDefinedShape 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.InDefinedShape 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: Implementation.Context

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

Specified by:

register in interface Implementation.Context

Parameters:

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

Returns:

A description of the registered auxiliary type.

isRetainTypeInitializer

public boolean isRetainTypeInitializer()

Description copied from interface: Implementation.Context.ExtractableView

Determines if this implementation context allows for the retention of a static type initializer.

Specified by:

isRetainTypeInitializer in interface Implementation.Context.ExtractableView

Returns:

true if the original type initializer can be retained. false if the original type initializer needs to be copied to another method for allowing code injection into the initializer.

getRegisteredAuxiliaryTypes

public List<DynamicType> getRegisteredAuxiliaryTypes()

Description copied from interface: Implementation.Context.ExtractableView

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

Specified by:

getRegisteredAuxiliaryTypes in interface Implementation.Context.ExtractableView

Returns:

A list of all manifested registered auxiliary types.

cache

public FieldDescription cache(StackManipulation fieldValue,
                              TypeDescription fieldType)

Description copied from interface: Implementation.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 Implementation.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(ClassVisitor classVisitor,
                  TypeWriter.MethodPool methodPool,
                  Implementation.Context.ExtractableView.InjectedCode injectedCode)

Description copied from interface: Implementation.Context.ExtractableView

Writes any information that was registered with an Implementation.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 Implementation.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