net.bytebuddy.dynamic.scaffold

Class InstrumentedType.Default

java.lang.Object

net.bytebuddy.description.ModifierReviewable.AbstractBase

net.bytebuddy.description.TypeVariableSource.AbstractBase

net.bytebuddy.description.type.TypeDescription.AbstractBase

net.bytebuddy.description.type.TypeDescription.AbstractBase.OfSimpleType

net.bytebuddy.dynamic.scaffold.InstrumentedType.Default

All Implemented Interfaces:

Iterable<TypeDefinition>, AnnotatedCodeElement, ByteCodeElement, DeclaredByType, ModifierReviewable, ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, NamedElement, NamedElement.WithRuntimeName, TypeDefinition, TypeDescription, TypeVariableSource, InstrumentedType, InstrumentedType.WithFlexibleName

Enclosing interface:

InstrumentedType

public static class InstrumentedType.Default
extends TypeDescription.AbstractBase.OfSimpleType
implements InstrumentedType.WithFlexibleName

A default implementation of an instrumented type.

Nested Class Summary

Nested classes/interfaces inherited from class net.bytebuddy.description.type.TypeDescription.AbstractBase.OfSimpleType

TypeDescription.AbstractBase.OfSimpleType.WithDelegation

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

TypeDescription.AbstractBase.OfSimpleType

Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.scaffold.InstrumentedType

InstrumentedType.Default, InstrumentedType.Prepareable, InstrumentedType.WithFlexibleName

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

TypeDescription.AbstractBase, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.ForPackageDescription, TypeDescription.Generic, TypeDescription.Latent

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

TypeDefinition.Sort, TypeDefinition.SuperClassIterator

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

ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration

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

ByteCodeElement.Token<T extends ByteCodeElement.Token<T>>, ByteCodeElement.TypeDependant<T extends ByteCodeElement.TypeDependant<?,S>,S extends ByteCodeElement.Token<S>>

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

NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

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

TypeVariableSource.Visitor<T>

Field Summary

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

ARRAY_INTERFACES, CLASS, OBJECT, STRING, THROWABLE, UNDEFINED, VOID

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Fields inherited from interface net.bytebuddy.description.ByteCodeElement

NON_GENERIC_SIGNATURE

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME, NO_NAME

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

Default(String name, int modifiers, TypeDescription.Generic superClass, List<? extends TypeVariableToken> typeVariables, List<? extends TypeDescription.Generic> interfaceTypes, List<? extends FieldDescription.Token> fieldTokens, List<? extends MethodDescription.Token> methodTokens, List<? extends AnnotationDescription> annotationDescriptions, TypeInitializer typeInitializer, LoadedTypeInitializer loadedTypeInitializer, TypeDescription declaringType, MethodDescription enclosingMethod, TypeDescription enclosingType, List<? extends TypeDescription> declaredTypes, boolean memberClass, boolean anonymousClass, boolean localClass) Creates a new instrumented type.

Method Summary

Modifier and Type	Method and Description
AnnotationList	getDeclaredAnnotations() Returns a list of annotations that are declared by this instance.
FieldList<FieldDescription.InDefinedShape>	getDeclaredFields() Returns the fields that this type declares.
MethodList<MethodDescription.InDefinedShape>	getDeclaredMethods() Returns the methods that this type declares.
TypeList	getDeclaredTypes() Returns a list of types that are declared by this type excluding anonymous classes.
TypeDescription	getDeclaringType() Returns the declaring type of this instance.
MethodDescription	getEnclosingMethod() Returns a description of the method that encloses this type.
TypeDescription	getEnclosingType() Returns a description of this type's enclosing type if any.
TypeList.Generic	getInterfaces() Returns the interfaces that this type implements.
LoadedTypeInitializer	getLoadedTypeInitializer() Returns the LoadedTypeInitializers that were registered for this instrumented type.
int	getModifiers() Returns the modifier that is described by this object.
String	getName() Returns the internalName of this byte code element.
PackageDescription	getPackage() Returns the package internalName of the type described by this instance.
TypeDescription.Generic	getSuperClass() Returns the super class of this type.
TypeInitializer	getTypeInitializer() Returns this instrumented type's type initializer.
TypeList.Generic	getTypeVariables() Returns the type variables that are declared by this element.
boolean	isAnonymousClass() Checks if this type description represents an anonymous type.
boolean	isLocalClass() Checks if this type description represents a local type.
boolean	isMemberClass() Checks if this type description represents a member type.
static InstrumentedType.WithFlexibleName	of(TypeDescription typeDescription) Creates an instrumented type that represents the given type description.
static InstrumentedType.WithFlexibleName	subclass(String name, int modifiers, TypeDescription.Generic superClass) Creates an instrumented type that is a subclass of the given super type named as given and with the modifiers.
TypeDescription	validated() Validates the instrumented type to define a legal Java type.
InstrumentedType.WithFlexibleName	withAnnotations(List<? extends AnnotationDescription> annotationDescriptions) Creates a new instrumented type with the given annotations.
InstrumentedType.WithFlexibleName	withField(FieldDescription.Token token) Creates a new instrumented type that includes a new field.
InstrumentedType.WithFlexibleName	withInitializer(ByteCodeAppender byteCodeAppender) Creates a new instrumented type that executes the given initializer in the instrumented type's type initializer.
InstrumentedType.WithFlexibleName	withInitializer(LoadedTypeInitializer loadedTypeInitializer) Creates a new instrumented type that includes the given LoadedTypeInitializer.
InstrumentedType.WithFlexibleName	withInterfaces(TypeList.Generic interfaceTypes) Creates a new instrumented type with the given interfaces implemented.
InstrumentedType.WithFlexibleName	withMethod(MethodDescription.Token token) Creates a new instrumented type that includes a new method or constructor.
InstrumentedType.WithFlexibleName	withModifiers(int modifiers) Creates a new instrumented type with changed modifiers.
InstrumentedType.WithFlexibleName	withName(String name) Creates a new instrumented type with a changed name.
InstrumentedType.WithFlexibleName	withTypeVariable(TypeVariableToken typeVariable) Creates a new instrumented type with the given type variable defined.
InstrumentedType.WithFlexibleName	withTypeVariables(ElementMatcher<? super TypeDescription.Generic> matcher, Transformer<TypeVariableToken> transformer) Applies a transformation onto all existing type variables of this instrumented type.

Methods inherited from class net.bytebuddy.description.type.TypeDescription.AbstractBase.OfSimpleType

getCanonicalName, getComponentType, getDescriptor, getSimpleName, getStackSize, isArray, isPrimitive

Methods inherited from class net.bytebuddy.description.type.TypeDescription.AbstractBase

accept, asErasure, asGenericType, equals, getActualModifiers, getActualName, getEnclosingSource, getGenericSignature, getInheritedAnnotations, getInternalName, getSegmentCount, getSort, getTypeName, hashCode, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isConstantPool, isGenericDeclaration, isInstance, isInstanceOrWrapper, isPackageType, isPrimitiveWrapper, isSamePackage, isVisibleTo, iterator, represents, toString

Methods inherited from class net.bytebuddy.description.TypeVariableSource.AbstractBase

findVariable

Methods inherited from class net.bytebuddy.description.ModifierReviewable.AbstractBase

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getActualModifiers, getCanonicalName, getComponentType, getInheritedAnnotations, getSegmentCount, getSimpleName, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isConstantPool, isInstance, isInstanceOrWrapper, isPackageType, isPrimitiveWrapper, isSamePackage

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

asErasure, asGenericType, getSort, getStackSize, getTypeName, isArray, isPrimitive, represents

Methods inherited from interface net.bytebuddy.description.ModifierReviewable.ForTypeDefinition

isAnnotation, isInterface

Methods inherited from interface net.bytebuddy.description.ModifierReviewable.OfAbstraction

isAbstract

Methods inherited from interface net.bytebuddy.description.ModifierReviewable.OfEnumeration

isEnum

Methods inherited from interface net.bytebuddy.description.ModifierReviewable.OfByteCodeElement

isDeprecated, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

isFinal, isSynthetic

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface net.bytebuddy.description.ByteCodeElement

getDescriptor, getGenericSignature, isVisibleTo

Methods inherited from interface net.bytebuddy.description.NamedElement.WithRuntimeName

getInternalName

Methods inherited from interface net.bytebuddy.description.NamedElement

getActualName

Methods inherited from interface net.bytebuddy.description.TypeVariableSource

accept, findVariable, getEnclosingSource, isGenericDeclaration

Constructor Detail

Default

protected Default(String name,
                  int modifiers,
                  TypeDescription.Generic superClass,
                  List<? extends TypeVariableToken> typeVariables,
                  List<? extends TypeDescription.Generic> interfaceTypes,
                  List<? extends FieldDescription.Token> fieldTokens,
                  List<? extends MethodDescription.Token> methodTokens,
                  List<? extends AnnotationDescription> annotationDescriptions,
                  TypeInitializer typeInitializer,
                  LoadedTypeInitializer loadedTypeInitializer,
                  TypeDescription declaringType,
                  MethodDescription enclosingMethod,
                  TypeDescription enclosingType,
                  List<? extends TypeDescription> declaredTypes,
                  boolean memberClass,
                  boolean anonymousClass,
                  boolean localClass)

Creates a new instrumented type.

Parameters:

name - The binary name of the instrumented type.

modifiers - The modifiers of the instrumented type.

typeVariables - The instrumented type's type variables in their tokenized form.

superClass - The generic super type of the instrumented type.

interfaceTypes - A list of interfaces of the instrumented type.

fieldTokens - A list of field tokens describing the fields of the instrumented type.

methodTokens - A list of method tokens describing the methods of the instrumented type.

annotationDescriptions - A list of annotations of the annotated type.

typeInitializer - The type initializer of the instrumented type.

loadedTypeInitializer - The loaded type initializer of the instrumented type.

declaringType - The declaring type of the instrumented type or null if no such type exists.

enclosingMethod - The enclosing method of the instrumented type or null if no such type exists.

enclosingType - The enclosing type of the instrumented type or null if no such type exists.

declaredTypes - A list of types that are declared by this type.

memberClass - true if this type is a member class.

anonymousClass - true if this type is a anonymous class.

localClass - true if this type is a local class.

Method Detail

subclass

public static InstrumentedType.WithFlexibleName subclass(String name,
                                                         int modifiers,
                                                         TypeDescription.Generic superClass)

Creates an instrumented type that is a subclass of the given super type named as given and with the modifiers.

Parameters:

name - The name of the instrumented type.

modifiers - The modifiers of the instrumented type.

superClass - The super type of the instrumented type.

Returns:

An instrumented type as a subclass of the given type with the given name and modifiers.

of

public static InstrumentedType.WithFlexibleName of(TypeDescription typeDescription)

Creates an instrumented type that represents the given type description.

Parameters:

typeDescription - A description of the type to represent.

Returns:

An instrumented type of the given type.

withModifiers

public InstrumentedType.WithFlexibleName withModifiers(int modifiers)

Description copied from interface: InstrumentedType

Creates a new instrumented type with changed modifiers.

Specified by:

withModifiers in interface InstrumentedType

Specified by:

withModifiers in interface InstrumentedType.WithFlexibleName

Parameters:

modifiers - The instrumented type's modifiers.

Returns:

A new instrumented type that is equal to this instrumented type but with the given modifiers.

withField

public InstrumentedType.WithFlexibleName withField(FieldDescription.Token token)

Description copied from interface: InstrumentedType

Creates a new instrumented type that includes a new field.

Specified by:

withField in interface InstrumentedType

Specified by:

withField in interface InstrumentedType.WithFlexibleName

Parameters:

token - A token that represents the field's shape. This token must represent types in their detached state.

Returns:

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

withMethod

public InstrumentedType.WithFlexibleName withMethod(MethodDescription.Token token)

Description copied from interface: InstrumentedType

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

Specified by:

withMethod in interface InstrumentedType

Specified by:

withMethod in interface InstrumentedType.WithFlexibleName

Parameters:

token - A token that represents the method's shape. This token must represent types in their detached state.

Returns:

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

withInterfaces

public InstrumentedType.WithFlexibleName withInterfaces(TypeList.Generic interfaceTypes)

Description copied from interface: InstrumentedType

Creates a new instrumented type with the given interfaces implemented.

Specified by:

withInterfaces in interface InstrumentedType

Specified by:

withInterfaces in interface InstrumentedType.WithFlexibleName

Parameters:

interfaceTypes - The interface types to implement.

Returns:

A new instrumented type that is equal to this instrumented type but with the given interfaces implemented.

withAnnotations

public InstrumentedType.WithFlexibleName withAnnotations(List<? extends AnnotationDescription> annotationDescriptions)

Description copied from interface: InstrumentedType

Creates a new instrumented type with the given annotations.

Specified by:

withAnnotations in interface InstrumentedType

Specified by:

withAnnotations in interface InstrumentedType.WithFlexibleName

Parameters:

annotationDescriptions - The annotations to add to the instrumented type.

Returns:

A new instrumented type that is equal to this instrumented type but annotated with the given annotations

withTypeVariable

public InstrumentedType.WithFlexibleName withTypeVariable(TypeVariableToken typeVariable)

Description copied from interface: InstrumentedType

Creates a new instrumented type with the given type variable defined.

Specified by:

withTypeVariable in interface InstrumentedType

Specified by:

withTypeVariable in interface InstrumentedType.WithFlexibleName

Parameters:

typeVariable - The type variable to declare.

Returns:

A new instrumented type that is equal to this instrumented type but with the given type variable declared.

withName

public InstrumentedType.WithFlexibleName withName(String name)

Description copied from interface: InstrumentedType.WithFlexibleName

Creates a new instrumented type with a changed name.

Specified by:

withName in interface InstrumentedType.WithFlexibleName

Parameters:

name - The name of the instrumented type.

Returns:

A new instrumented type that has the given name.

withTypeVariables

public InstrumentedType.WithFlexibleName withTypeVariables(ElementMatcher<? super TypeDescription.Generic> matcher,
                                                           Transformer<TypeVariableToken> transformer)

Description copied from interface: InstrumentedType.WithFlexibleName

Applies a transformation onto all existing type variables of this instrumented type. A transformation is potentially unsafe and it is the responsibility of the supplier to return a valid type variable token from the transformer.

Specified by:

withTypeVariables in interface InstrumentedType.WithFlexibleName

Parameters:

matcher - The matcher to decide what type variables to transform.

transformer - The transformer to apply on all matched type variables.

Returns:

A new instrumented type with all matched type variables transformed.

withInitializer

public InstrumentedType.WithFlexibleName withInitializer(LoadedTypeInitializer loadedTypeInitializer)

Description copied from interface: InstrumentedType

Creates a new instrumented type that includes the given LoadedTypeInitializer.

Specified by:

withInitializer in interface InstrumentedType

Specified by:

withInitializer in interface InstrumentedType.WithFlexibleName

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

public InstrumentedType.WithFlexibleName withInitializer(ByteCodeAppender byteCodeAppender)

Description copied from interface: InstrumentedType

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

Specified by:

withInitializer in interface InstrumentedType

Specified by:

withInitializer in interface InstrumentedType.WithFlexibleName

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

public LoadedTypeInitializer getLoadedTypeInitializer()

Description copied from interface: InstrumentedType

Returns the LoadedTypeInitializers that were registered for this instrumented type.

Specified by:

getLoadedTypeInitializer in interface InstrumentedType

Returns:

The registered loaded type initializers for this instrumented type.

getTypeInitializer

public TypeInitializer getTypeInitializer()

Description copied from interface: InstrumentedType

Returns this instrumented type's type initializer.

Specified by:

getTypeInitializer in interface InstrumentedType

Returns:

This instrumented type's type initializer.

getEnclosingMethod

public MethodDescription getEnclosingMethod()

Description copied from interface: TypeDescription

Returns a description of the method that encloses this type. If this method is not enclosed by any type or is enclosed by the type initializer, null is returned by this method.

Specified by:

getEnclosingMethod in interface TypeDescription

Returns:

A description of the enclosing method of this type or null if there is no such method.

getEnclosingType

public TypeDescription getEnclosingType()

Description copied from interface: TypeDescription

Returns a description of this type's enclosing type if any.

Specified by:

getEnclosingType in interface TypeDescription

Returns:

A description of the enclosing type of this type or null if there is no such type.

getDeclaredTypes

public TypeList getDeclaredTypes()

Description copied from interface: TypeDescription

Returns a list of types that are declared by this type excluding anonymous classes.

Specified by:

getDeclaredTypes in interface TypeDescription

Returns:

A list of types that are declared within this type.

isAnonymousClass

public boolean isAnonymousClass()

Description copied from interface: TypeDescription

Checks if this type description represents an anonymous type.

Specified by:

isAnonymousClass in interface TypeDescription

Returns:

true if this type description represents an anonymous type.

isLocalClass

public boolean isLocalClass()

Description copied from interface: TypeDescription

Checks if this type description represents a local type.

Specified by:

isLocalClass in interface TypeDescription

Returns:

true if this type description represents a local type.

isMemberClass

public boolean isMemberClass()

Description copied from interface: TypeDescription

Checks if this type description represents a member type.

Specified by:

isMemberClass in interface TypeDescription

Returns:

true if this type description represents a member type.

getPackage

public PackageDescription getPackage()

Description copied from interface: TypeDescription

Returns the package internalName of the type described by this instance.

Specified by:

getPackage in interface TypeDescription

Returns:

The package internalName of the type described by this instance.

getDeclaredAnnotations

public AnnotationList getDeclaredAnnotations()

Description copied from interface: AnnotatedCodeElement

Returns a list of annotations that are declared by this instance.

Specified by:

getDeclaredAnnotations in interface AnnotatedCodeElement

Returns:

A list of declared annotations.

getDeclaringType

public TypeDescription getDeclaringType()

Description copied from interface: DeclaredByType

Returns the declaring type of this instance.

Specified by:

getDeclaringType in interface DeclaredByType

Specified by:

getDeclaringType in interface TypeDescription

Returns:

The declaring type or null if no such type exists.

getSuperClass

public TypeDescription.Generic getSuperClass()

Description copied from interface: TypeDefinition

Returns the super class of this type. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Interface types and the Object class do not define a super class where null is returned. Array types define Object as their direct super class.

Specified by:

getSuperClass in interface TypeDefinition

Returns:

The super class of this type or null if no super class exists for this type.

getInterfaces

public TypeList.Generic getInterfaces()

Description copied from interface: TypeDefinition

Returns the interfaces that this type implements. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types.

Specified by:

getInterfaces in interface TypeDefinition

Returns:

The interfaces that this type implements.

getDeclaredFields

public FieldList<FieldDescription.InDefinedShape> getDeclaredFields()

Description copied from interface: TypeDefinition

Returns the fields that this type declares. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Generic array types never define fields and the returned list is always empty for such types.

Specified by:

getDeclaredFields in interface TypeDefinition

Specified by:

getDeclaredFields in interface TypeDescription

Returns:

The fields that this type declares. A super type is only defined for non-generic types (TypeDefinition.Sort.NON_GENERIC), parameterized types (TypeDefinition.Sort.PARAMETERIZED) or generic array types (TypeDefinition.Sort.GENERIC_ARRAY) types. Generic array types never define methods and the returned list is always empty for such types.

getDeclaredMethods

public MethodList<MethodDescription.InDefinedShape> getDeclaredMethods()

Description copied from interface: TypeDefinition

Returns the methods that this type declares.

Specified by:

getDeclaredMethods in interface TypeDefinition

Specified by:

getDeclaredMethods in interface TypeDescription

Returns:

The methods that this type declares.

getTypeVariables

public TypeList.Generic getTypeVariables()

Description copied from interface: TypeVariableSource

Returns the type variables that are declared by this element.

Specified by:

getTypeVariables in interface TypeVariableSource

Returns:

The type variables that are declared by this element.

getModifiers

public int getModifiers()

Description copied from interface: ModifierReviewable

Returns the modifier that is described by this object.

Specified by:

getModifiers in interface ModifierReviewable

Returns:

The modifier that is described by this object.

getName

public String getName()

Description copied from interface: NamedElement.WithRuntimeName

Returns the internalName of this byte code element.

Specified by:

getName in interface NamedElement.WithRuntimeName

Returns:

The internalName of this byte code element as visible from within a running Java application.

validated

public TypeDescription validated()

Description copied from interface: InstrumentedType

Validates the instrumented type to define a legal Java type.

Specified by:

validated in interface InstrumentedType

Returns:

This instrumented type as a non-modifiable type description.