net.bytebuddy.dynamic.scaffold

Interface InstrumentedType

All Superinterfaces:

AnnotatedCodeElement, ByteCodeElement, DeclaredInType, ModifierReviewable, NamedElement, TypeDescription

All Known Implementing Classes:

InlineInstrumentedType, InstrumentedType.AbstractBase, SubclassInstrumentedType

public interface InstrumentedType
extends TypeDescription

Implementations of this interface represent an instrumented type that is subject to change. Implementations should however be immutable and return new instance when their mutator methods are called.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstrumentedType.AbstractBase An abstract base implementation of an instrumented type.
static interface	InstrumentedType.TypeInitializer A type initializer is responsible for defining a type's static initialization block.

Nested classes/interfaces inherited from interface net.bytebuddy.description.type.TypeDescription

TypeDescription.AbstractTypeDescription, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.Latent

Nested classes/interfaces inherited from interface net.bytebuddy.description.ModifierReviewable

ModifierReviewable.AbstractModifierReviewable

Field Summary

Fields inherited from interface net.bytebuddy.description.type.TypeDescription

CLASS, ENUM, OBJECT, STRING, VOID

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Method Summary

Modifier and Type	Method and Description
TypeDescription	detach() Creates a compressed version of this instrumented type which only needs to fulfil the TypeDescription interface.
LoadedTypeInitializer	getLoadedTypeInitializer() Returns the LoadedTypeInitializers that were registered for this instrumented type.
InstrumentedType.TypeInitializer	getTypeInitializer() Returns this instrumented type's type initializer.
InstrumentedType	withField(String internalName, TypeDescription fieldType, int modifiers) Creates a new instrumented type that includes a new field.
InstrumentedType	withInitializer(ByteCodeAppender byteCodeAppender) Creates a new instrumented type that executes the given initializer in the instrumented type's type initializer.
InstrumentedType	withInitializer(LoadedTypeInitializer loadedTypeInitializer) Creates a new instrumented type that includes the given LoadedTypeInitializer.
InstrumentedType	withMethod(String internalName, TypeDescription returnType, List<? extends TypeDescription> parameterTypes, List<? extends TypeDescription> exceptionTypes, int modifiers) Creates a new instrumented type that includes a new method or constructor.

Methods inherited from interface net.bytebuddy.description.type.TypeDescription

getActualModifiers, getCanonicalName, getComponentType, getDeclaredFields, getDeclaredMethods, getEnclosingMethod, getEnclosingType, getInheritedAnnotations, getInheritedInterfaces, getInterfaces, getPackage, getSimpleName, getStackSize, getSupertype, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAnonymousClass, isArray, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isConstantPool, isInstance, isInstanceOrWrapper, isLocalClass, isMemberClass, isPrimitive, isPrimitiveWrapper, isSamePackage, represents

Methods inherited from interface net.bytebuddy.description.ByteCodeElement

getDescriptor, getGenericSignature, isVisibleTo

Methods inherited from interface net.bytebuddy.description.NamedElement

getInternalName, getName, getSourceCodeName

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getModifiers, isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Methods inherited from interface net.bytebuddy.description.type.DeclaredInType

getDeclaringType

Methods inherited from interface net.bytebuddy.description.annotation.AnnotatedCodeElement

getDeclaredAnnotations

Method Detail

withField

InstrumentedType withField(String internalName,
                           TypeDescription fieldType,
                           int modifiers)

Creates a new instrumented type that includes a new field.

Parameters:

internalName - The internal name of the new field.

fieldType - A description of the type of the new field.

modifiers - The modifier of the new field.

Returns:

A new instrumented type that is equal to this instrumented type but with the additional field.

withMethod

InstrumentedType withMethod(String internalName,
                            TypeDescription returnType,
                            List<? extends TypeDescription> parameterTypes,
                            List<? extends TypeDescription> exceptionTypes,
                            int modifiers)

Creates a new instrumented type that includes a new method or constructor.

Parameters:

internalName - The internal name of the new field.

returnType - A description of the return type of the new field.

parameterTypes - A list of descriptions of the parameter types.

exceptionTypes - A list of descriptions of the exception types that are declared by this method.

modifiers - The modifier of the new field.

Returns:

A new instrumented type that is equal to this instrumented type but with the additional field.

withInitializer

InstrumentedType withInitializer(LoadedTypeInitializer loadedTypeInitializer)

Creates a new instrumented type that includes the given LoadedTypeInitializer.

Parameters:

loadedTypeInitializer - The type initializer to include.

Returns:

A new instrumented type that is equal to this instrumented type but with the additional type initializer.

withInitializer

InstrumentedType withInitializer(ByteCodeAppender byteCodeAppender)

Creates a new instrumented type that executes the given initializer in the instrumented type's type initializer.

Parameters:

byteCodeAppender - The byte code to add to the type initializer.

Returns:

A new instrumented type that is equal to this instrumented type but with the given stack manipulation attached to its type initializer.

getLoadedTypeInitializer

LoadedTypeInitializer getLoadedTypeInitializer()

Returns the LoadedTypeInitializers that were registered for this instrumented type.

Returns:

The registered loaded type initializers for this instrumented type.

getTypeInitializer

InstrumentedType.TypeInitializer getTypeInitializer()

Returns this instrumented type's type initializer.

Returns:

This instrumented type's type initializer.

detach

TypeDescription detach()

Creates a compressed version of this instrumented type which only needs to fulfil the TypeDescription interface. This allows for a potential compression of the representation of this instrumented type.

Returns:

A (potentially) compressed version of this instrumented type.