net.bytebuddy.pool

Class TypePool.Default.LazyTypeDescription

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.pool.TypePool.Default.LazyTypeDescription

All Implemented Interfaces:

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

Enclosing class:

TypePool.Default

protected static class TypePool.Default.LazyTypeDescription
extends TypeDescription.AbstractBase.OfSimpleType

A type description that looks up any referenced ByteCodeElement or AnnotationDescription by querying a type pool at lookup time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TypePool.Default.LazyTypeDescription.AnnotationToken A token for representing collected data on an annotation.
protected static class	TypePool.Default.LazyTypeDescription.FieldToken A token for representing collected data on a field.
protected class	TypePool.Default.LazyTypeDescription.FieldTokenList A list of field tokens representing each entry as a field description.
protected static interface	TypePool.Default.LazyTypeDescription.GenericTypeToken A token that represents a generic Java type.
protected static class	TypePool.Default.LazyTypeDescription.LazyNestMemberList A lazy list that represents all nest members of the represented type.
protected static class	TypePool.Default.LazyTypeDescription.LazyTypeList A list that is constructing TypePool.Default.WithLazyResolution.LazyTypeDescriptions.
protected static class	TypePool.Default.LazyTypeDescription.MethodToken A token for representing collected data on a method.
protected class	TypePool.Default.LazyTypeDescription.MethodTokenList A list of method tokens representing each entry as a method description.
protected static class	TypePool.Default.LazyTypeDescription.RecordComponentToken A token representing a record component.
protected class	TypePool.Default.LazyTypeDescription.RecordComponentTokenList A list of record component tokens representing each record component as a description.
protected static class	TypePool.Default.LazyTypeDescription.TokenizedGenericType A representation of a generic type that is described by a TypePool.Default.LazyTypeDescription.GenericTypeToken.
protected static interface	TypePool.Default.LazyTypeDescription.TypeContainment A declaration context encapsulates information about whether a type was declared within another type or within a method of another type.

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.description.type.TypeDescription

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

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.Member, 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.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

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

DeclaredByType.WithMandatoryDeclaration

Nested classes/interfaces inherited from interface net.bytebuddy.description.annotation.AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

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

TypeVariableSource.Visitor<T>

Field Summary

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

RAW_TYPES

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

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

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

RAW_TYPES_PROPERTY

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Fields inherited from interface net.bytebuddy.description.NamedElement.WithDescriptor

NON_GENERIC_SIGNATURE

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME, NO_NAME

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

LazyTypeDescription(TypePool typePool, int actualModifiers, int modifiers, String name, String superClassInternalName, String[] interfaceInternalName, String genericSignature, TypePool.Default.LazyTypeDescription.TypeContainment typeContainment, String declaringTypeInternalName, List<String> declaredTypes, boolean anonymousType, String nestHostInternalName, List<String> nestMemberInternalNames, Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>> superClassAnnotationTokens, Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>> interfaceAnnotationTokens, Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>> typeVariableAnnotationTokens, Map<Integer,Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>>> typeVariableBoundsAnnotationTokens, List<TypePool.Default.LazyTypeDescription.AnnotationToken> annotationTokens, List<TypePool.Default.LazyTypeDescription.FieldToken> fieldTokens, List<TypePool.Default.LazyTypeDescription.MethodToken> methodTokens, List<TypePool.Default.LazyTypeDescription.RecordComponentToken> recordComponentTokens, List<String> permittedSubclasses, ClassFileVersion classFileVersion) Creates a new lazy type description.

Method Summary

Modifier and Type	Method and Description
int	getActualModifiers(boolean superFlag) Returns the type's actual modifiers as present in the class file.
ClassFileVersion	getClassFileVersion() Attempts to resolve the class file version of this type.
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.
TypeDescription	getDeclaringType() Returns the declaring type of this instance.
MethodDescription.InDefinedShape	getEnclosingMethod() Returns a description of the method that encloses this type.
TypeDescription	getEnclosingType() Returns a description of this type's enclosing type if any.
String	getGenericSignature() Returns the generic signature of this byte code element.
TypeList.Generic	getInterfaces() Returns the interfaces that this type implements.
int	getModifiers() Returns the modifier that is described by this object.
String	getName() Returns the binary name of this byte code element.
TypeDescription	getNestHost() Returns the nest host of this type.
TypeList	getNestMembers() Returns a list of members that are part of a nesting group.
PackageDescription	getPackage() Returns the package of the type described by this instance or null if the described type is a primitive type or an array.
TypeList	getPermittedSubtypes() Returns the list of permitted direct subclasses if this class is a sealed class.
RecordComponentList<RecordComponentDescription.InDefinedShape>	getRecordComponents() Returns the list of record components that are declared by this type.
TypeDescription.Generic	getSuperClass() Returns the super class of this type.
TypeList.Generic	getTypeVariables() Returns the type variables that are declared by this element.
boolean	isAnonymousType() Checks if this type description represents an anonymous type.
boolean	isLocalType() Checks if this type description represents a local type.
boolean	isRecord() Checks if this type is a Java record.
boolean	isSealed() Returns true if this class is a sealed class that only permitts a specified range of subclasses.

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, asBoxed, asErasure, asGenericType, asUnboxed, equals, getActualName, getDefaultValue, getEnclosingSource, getInheritedAnnotations, getInnerClassCount, getInternalName, getLongSimpleName, getSort, getTypeName, hashCode, isAccessibleTo, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isCompileTimeConstant, isGenerified, isInferrable, isInHierarchyWith, isInHierarchyWith, isInnerClass, isInstance, isMemberType, isNestedClass, isNestHost, isNestMateOf, isNestMateOf, isPackageType, isPrimitiveWrapper, isSamePackage, isVisibleTo, iterator, represents, toSafeString, toString

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

findExpectedVariable, findVariable

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

getEnumerationState, getFieldManifestation, getFieldPersistence, getMethodManifestation, getMethodStrictness, getOwnership, getParameterManifestation, getProvisioningState, getSynchronizationState, getSyntheticState, getTypeManifestation, getVisibility, 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.ModifierReviewable.ForTypeDefinition

getTypeManifestation, isAnnotation, isInterface

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

isAbstract

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

getEnumerationState, isEnum

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

getOwnership, getVisibility, isDeprecated, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getSyntheticState, isFinal, isSynthetic

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.bytebuddy.description.TypeVariableSource

findExpectedVariable, findVariable

Constructor Detail

LazyTypeDescription

protected LazyTypeDescription(TypePool typePool,
                              int actualModifiers,
                              int modifiers,
                              String name,
                              @MaybeNull
                              String superClassInternalName,
                              @MaybeNull
                              String[] interfaceInternalName,
                              @MaybeNull
                              String genericSignature,
                              TypePool.Default.LazyTypeDescription.TypeContainment typeContainment,
                              @MaybeNull
                              String declaringTypeInternalName,
                              List<String> declaredTypes,
                              boolean anonymousType,
                              @MaybeNull
                              String nestHostInternalName,
                              List<String> nestMemberInternalNames,
                              Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>> superClassAnnotationTokens,
                              Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>> interfaceAnnotationTokens,
                              Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>> typeVariableAnnotationTokens,
                              Map<Integer,Map<Integer,Map<String,List<TypePool.Default.LazyTypeDescription.AnnotationToken>>>> typeVariableBoundsAnnotationTokens,
                              List<TypePool.Default.LazyTypeDescription.AnnotationToken> annotationTokens,
                              List<TypePool.Default.LazyTypeDescription.FieldToken> fieldTokens,
                              List<TypePool.Default.LazyTypeDescription.MethodToken> methodTokens,
                              List<TypePool.Default.LazyTypeDescription.RecordComponentToken> recordComponentTokens,
                              List<String> permittedSubclasses,
                              ClassFileVersion classFileVersion)

Creates a new lazy type description.

Parameters:

typePool - The type pool to be used for looking up linked types.

actualModifiers - The actual modifiers of this type.

modifiers - The modifiers of this type.

name - The binary name of this type.

superClassInternalName - The internal name of this type's super type or null if no such super type is defined.

interfaceInternalName - An array of this type's interfaces or null if this type does not define any interfaces.

genericSignature - The type's generic signature as found in the class file or null if the type is not generic.

typeContainment - A definition of this type's containment within another type or method.

declaringTypeInternalName - The internal name of this type's declaring type or null if no such type exists.

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

anonymousType - true if this type is an anonymous type.

nestHostInternalName - The internal name of the nest host or null if no nest host was specified.

nestMemberInternalNames - A list of internal names of the nest members.

superClassAnnotationTokens - A mapping of the super class's annotation tokens.

interfaceAnnotationTokens - A mapping of type annotations for this type's interface types by their indices.

typeVariableAnnotationTokens - A mapping of type annotations of the type variables' type annotations by their indices.

typeVariableBoundsAnnotationTokens - A mapping of type annotations of the type variables' bounds' type annotations by their indices and each variable's index.

annotationTokens - A list of tokens that represent the annotations of this type.

fieldTokens - A list of field tokens describing the field's of this type.

methodTokens - A list of method tokens describing the method's of this type.

recordComponentTokens - A list of record component tokens describing the record components of this type.

permittedSubclasses - A list of internal names of permitted subclasses.

classFileVersion - The type's class file version.

Method Detail

getSuperClass

@MaybeNull
public TypeDescription.Generic getSuperClass()

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.

Returns:

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

getInterfaces

public TypeList.Generic getInterfaces()

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.

Returns:

The interfaces that this type implements.

getEnclosingMethod

@MaybeNull
public MethodDescription.InDefinedShape getEnclosingMethod()

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.

Returns:

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

getEnclosingType

@MaybeNull
public TypeDescription getEnclosingType()

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

Returns:

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

getDeclaredTypes

public TypeList getDeclaredTypes()

Returns a list of types that are declared by this type. This list does not normally include anonymous types but might include additional types if they are explicitly added to an instrumented type.

Returns:

A list of types that are declared within this type.

isAnonymousType

public boolean isAnonymousType()

Checks if this type description represents an anonymous type.

Returns:

true if this type description represents an anonymous type.

isLocalType

public boolean isLocalType()

Checks if this type description represents a local type.

Returns:

true if this type description represents a local type.

getDeclaredFields

public FieldList<FieldDescription.InDefinedShape> getDeclaredFields()

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.

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()

Returns the methods that this type declares.

Returns:

The methods that this type declares.

getPackage

@MaybeNull
public PackageDescription getPackage()

Returns the package of the type described by this instance or null if the described type is a primitive type or an array.

Returns:

The package of the type described by this instance or null if the described type is a primitive type or an array.

getName

public String getName()

Returns the binary name of this byte code element. If no well-defined internal name is known for this element, the actual name is returned.

Returns:

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

getDeclaringType

@MaybeNull
public TypeDescription getDeclaringType()

Returns the declaring type of this instance.

Returns:

The declaring type or null if no such type exists.

getModifiers

public int getModifiers()

Returns the modifier that is described by this object.

Returns:

The modifier that is described by this object.

getActualModifiers

public int getActualModifiers(boolean superFlag)

Returns the type's actual modifiers as present in the class file. For example, a type cannot be private. but it modifiers might reflect this property nevertheless if a class was defined as a private inner class. The returned modifiers take also into account if the type is marked as Deprecated. Anonymous classes that are enclosed in a static method or the type initializer are additionally marked as final as it is also done by the Java compiler.

Specified by:

getActualModifiers in interface TypeDescription

Overrides:

getActualModifiers in class TypeDescription.AbstractBase

Parameters:

superFlag - true if the modifier's super flag should be set.

Returns:

The type's actual modifiers.

getNestHost

public TypeDescription getNestHost()

Returns the nest host of this type. For types prior to Java 11, this type is returned which is the default nest host.

Returns:

The nest host of this type.

getNestMembers

public TypeList getNestMembers()

Returns a list of members that are part of a nesting group. Prior to Java 11, a list that only contains this type is returned which is the default nest group.

Returns:

A list of members of this nest group.

getDeclaredAnnotations

public AnnotationList getDeclaredAnnotations()

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

Returns:

A list of declared annotations.

getTypeVariables

public TypeList.Generic getTypeVariables()

Returns the type variables that are declared by this element.

Returns:

The type variables that are declared by this element.

getGenericSignature

@MaybeNull
public String getGenericSignature()

Description copied from class: TypeDescription.AbstractBase

Returns the generic signature of this byte code element. If this element does not reference generic types or references malformed generic types, null is returned as a signature.

Specified by:

getGenericSignature in interface NamedElement.WithDescriptor

Overrides:

getGenericSignature in class TypeDescription.AbstractBase

Returns:

The generic signature or null if this element is not generic.

getRecordComponents

public RecordComponentList<RecordComponentDescription.InDefinedShape> getRecordComponents()

Returns the list of record components that are declared by this type. If this type is not a record, the returned list is empty.

Returns:

A list of record components that this type declares.

isRecord

public boolean isRecord()

Checks if this type is a Java record.

Returns:

true if this type is a Java record.

isSealed

public boolean isSealed()

Description copied from class: TypeDescription.AbstractBase

Returns true if this class is a sealed class that only permitts a specified range of subclasses.

Specified by:

isSealed in interface TypeDescription

Overrides:

isSealed in class TypeDescription.AbstractBase

Returns:

true if this class is a sealed class that only permitts a specified range of subclasses.

getPermittedSubtypes

public TypeList getPermittedSubtypes()

Returns the list of permitted direct subclasses if this class is a sealed class. Permitted subclasses might or might not be resolvable, where unresolvable subclasses might also be missing from the list. For returned types, methods that return the class's name will always be invokable without errors. If this type is not sealed, an empty list is returned. Note that an empty list might also be returned for a sealed type, if no type permitted subtype is resolvable.

Returns:

The list of permitted subtypes or an empty list if this type is not sealed.

getClassFileVersion

public ClassFileVersion getClassFileVersion()

Description copied from class: TypeDescription.AbstractBase

Attempts to resolve the class file version of this type. If this description is not based on a class file or if the class file version cannot be resolved, null is returned.

Specified by:

getClassFileVersion in interface TypeDescription

Overrides:

getClassFileVersion in class TypeDescription.AbstractBase

Returns:

This type's class file version or null if it cannot be resolved.