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>, AnnotationSource, ByteCodeElement, DeclaredByType, ModifierReviewable, ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForModuleDescription, ModifierReviewable.ForModuleRequirement, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, ModifierReviewable.OfMandatable, NamedElement, NamedElement.WithDescriptor, 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 TypeDescription.AbstractBase.OfSimpleType

TypeDescription.AbstractBase.OfSimpleType.WithDelegation

Nested classes/interfaces inherited from class TypeDescription.AbstractBase

TypeDescription.AbstractBase.OfSimpleType

Nested classes/interfaces inherited from interface AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

Nested classes/interfaces inherited from interface ByteCodeElement

ByteCodeElement.Member, ByteCodeElement.Token<T>, ByteCodeElement.TypeDependant<T,S>

Nested classes/interfaces inherited from interface DeclaredByType

DeclaredByType.WithMandatoryDeclaration

Nested classes/interfaces inherited from interface InstrumentedType

InstrumentedType.Default, InstrumentedType.Factory, InstrumentedType.Frozen, InstrumentedType.Prepareable, InstrumentedType.WithFlexibleName

Nested classes/interfaces inherited from interface ModifierReviewable

ModifierReviewable.AbstractBase, ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForModuleDescription, ModifierReviewable.ForModuleRequirement, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, ModifierReviewable.OfMandatable

Nested classes/interfaces inherited from interface NamedElement

NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

Nested classes/interfaces inherited from interface TypeDefinition

TypeDefinition.Sort, TypeDefinition.SuperClassIterator

Nested classes/interfaces inherited from interface TypeDescription

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

Nested classes/interfaces inherited from interface TypeVariableSource

TypeVariableSource.AbstractBase, TypeVariableSource.Visitor<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final List<? extends AnnotationDescription>	annotationDescriptions	A list of annotations of the annotated type.
private final boolean	anonymousClass	true if this type is an anonymous class.
private final Map<String,Object>	auxiliaryFields	A mapping of auxiliary field names to their mapped values.
private final List<? extends TypeDescription>	declaredTypes	A list of types that are declared by this type.
private final TypeDescription	declaringType	The declaring type of the instrumented type or null if no such type exists.
private final MethodDescription.InDefinedShape	enclosingMethod	The enclosing method of the instrumented type or null if no such type exists.
private final TypeDescription	enclosingType	The enclosing type of the instrumented type or null if no such type exists.
private final List<? extends FieldDescription.Token>	fieldTokens	A list of field tokens describing the fields of the instrumented type.
private final List<? extends TypeDescription.Generic>	interfaceTypes	A list of interfaces of the instrumented type.
private static final Set<String>	KEYWORDS	A set containing all keywords of the Java programming language.
private final LoadedTypeInitializer	loadedTypeInitializer	The loaded type initializer of the instrumented type.
private final boolean	localClass	true if this type is a local class.
private final List<? extends MethodDescription.Token>	methodTokens	A list of method tokens describing the methods of the instrumented type.
private final int	modifiers	The modifiers of the instrumented type.
private final ModuleDescription	moduleDescription	The module metadata that this type implies or null.
private final String	name	The binary name of the instrumented type.
private final TypeDescription	nestHost	The nest host of this instrumented type or a description of TargetType if this type is its own nest host.
private final List<? extends TypeDescription>	nestMembers	A list of all members of this types nest group excluding this type.
private final List<? extends TypeDescription>	permittedSubclasses	A list of permitted subclasses or null if this type is not sealed.
private final boolean	record	true if this class is a record class.
private final List<? extends RecordComponentDescription.Token>	recordComponentTokens	A list of record component tokens describing the record components of the instrumented type.
private final TypeDescription.Generic	superClass	The generic super type of the instrumented type.
private final TypeInitializer	typeInitializer	The type initializer of the instrumented type.
private final List<? extends TypeVariableToken>	typeVariables	The instrumented type's type variables in their tokenized form.

Fields inherited from class TypeDescription.AbstractBase

RAW_TYPES

Fields inherited from interface ModifierReviewable

EMPTY_MASK

Fields inherited from interface NamedElement

EMPTY_NAME, NO_NAME

Fields inherited from interface NamedElement.WithDescriptor

NON_GENERIC_SIGNATURE

Fields inherited from interface TypeDefinition

RAW_TYPES_PROPERTY

Fields inherited from interface TypeDescription

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

Fields inherited from interface TypeVariableSource

UNDEFINED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default(String name, int modifiers, ModuleDescription moduleDescription, List<? extends TypeVariableToken> typeVariables, TypeDescription.Generic superClass, List<? extends TypeDescription.Generic> interfaceTypes, List<? extends FieldDescription.Token> fieldTokens, Map<String,Object> auxiliaryFieldValues, List<? extends MethodDescription.Token> methodTokens, List<? extends RecordComponentDescription.Token> recordComponentTokens, List<? extends AnnotationDescription> annotationDescriptions, TypeInitializer typeInitializer, LoadedTypeInitializer loadedTypeInitializer, TypeDescription declaringType, MethodDescription.InDefinedShape enclosingMethod, TypeDescription enclosingType, List<? extends TypeDescription> declaredTypes, List<? extends TypeDescription> permittedSubclasses, boolean anonymousClass, boolean localClass, boolean record, TypeDescription nestHost, List<? extends TypeDescription> nestMembers)	Creates a new instrumented type.

Method Summary

Modifier and Type	Method	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.
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.
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 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.
TypeInitializer	getTypeInitializer()	Returns this instrumented type's type initializer.
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.
private static boolean	isValidIdentifier(String identifier)	Checks if a Java identifier is valid.
private static boolean	isValidIdentifier(String[] identifier)	Checks if an array of identifiers is a valid compound Java identifier.
private static boolean	isValidMethodIdentifier(String identifier)	Checks if an identifier is a valid "Unqualified Name" for a method, per JVMS 4.2.2.
private static boolean	isValidUnqualifiedNameIdentifier(String identifier)	Checks if an identifier is a valid "Unqualified Name" for a field, a local variable or a formal parameter, per JVMS 4.2.2.
static InstrumentedType	of(String name, TypeDescription.Generic superClass, int modifiers)	Creates a new instrumented type.
static InstrumentedType	of(String name, TypeDescription.Generic superClass, ModifierContributor.ForType... modifierContributor)	Creates a new instrumented type.
ModuleDescription	toModuleDescription()	Returns a representation of a Java module that is represented by this type description, normally a module-info.class file.
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	withAnonymousClass(boolean anonymousClass)	Creates a new instrumented type that indicates that it is defined as an anonymous class.
InstrumentedType.WithFlexibleName	withAuxiliaryField(FieldDescription.Token token, Object value)	Creates a new instrumented type that includes a new field.
InstrumentedType.WithFlexibleName	withDeclaredTypes(TypeList declaredTypes)	Creates a new instrumented type that indicates that it declared the supplied types.
InstrumentedType.WithFlexibleName	withDeclaringType(TypeDescription declaringType)	Creates a new instrumented type that is declared by the supplied type.
InstrumentedType.WithFlexibleName	withEnclosingMethod(MethodDescription.InDefinedShape enclosingMethod)	Creates a new instrumented type with the supplied enclosing method.
InstrumentedType.WithFlexibleName	withEnclosingType(TypeDescription enclosingType)	Creates a new instrumented type with the supplied enclosing type.
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	withLocalClass(boolean localClass)	Creates a new instrumented type that indicates that is defined as a local class.
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	withModuleDescription(ModuleDescription moduleDescription)	Creates a new instrumented type that defines the provided module metadata or no such metadata if null is provided.
InstrumentedType.WithFlexibleName	withName(String name)	Creates a new instrumented type with a changed name.
InstrumentedType.WithFlexibleName	withNestHost(TypeDescription nestHost)	Creates a new instrumented type with the supplied nest host.
InstrumentedType.WithFlexibleName	withNestMembers(TypeList nestMembers)	Creates a new instrumented types with the supplied nest members added to this instrumented type.
InstrumentedType.WithFlexibleName	withPermittedSubclasses(TypeList permittedSubclasses)	Creates a new instrumented type that includes the supplied permitted subclasses or unseals the type.
InstrumentedType.WithFlexibleName	withRecord(boolean record)	Creates a new instrumented type that indicates that it defined as a record type.
InstrumentedType.WithFlexibleName	withRecordComponent(RecordComponentDescription.Token token)	Creates a new instrumented type that includes a new record component.
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 TypeDescription.AbstractBase.OfSimpleType

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

Methods inherited from class TypeDescription.AbstractBase

accept, asBoxed, asErasure, asGenericType, asUnboxed, equals, getActualModifiers, getActualName, getClassFileVersion, getDefaultValue, getEnclosingSource, getGenericSignature, getInheritedAnnotations, getInnerClassCount, getInternalName, getLongSimpleName, getSort, getTypeName, hashCode, isAccessibleTo, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isCompileTimeConstant, isGenerified, isInferrable, isInHierarchyWith, isInHierarchyWith, isInnerClass, isInstance, isMemberType, isModuleType, isNestedClass, isNestHost, isNestMateOf, isNestMateOf, isPackageType, isPrimitiveWrapper, isSamePackage, isVisibleTo, iterator, represents, toSafeString, toString

Methods inherited from class TypeVariableSource.AbstractBase

findExpectedVariable, findVariable

Methods inherited from class ModifierReviewable.AbstractBase

getEnumerationState, getFieldManifestation, getFieldPersistence, getMandate, getMethodManifestation, getMethodStrictness, getOpenness, getOwnership, getParameterManifestation, getProvisioningState, getRequiredPhase, getSynchronizationState, getSyntheticState, getTransitivity, getTypeManifestation, getVisibility, isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isOpen, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStaticPhase, isStrict, isSynchronized, isSynthetic, isTransient, isTransitive, isVarArgs, isVolatile

Methods inherited from class Object

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

Methods inherited from interface ByteCodeElement

isAccessibleTo, isVisibleTo

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface ModifierReviewable

getSyntheticState, isFinal, isSynthetic

Methods inherited from interface ModifierReviewable.ForTypeDefinition

getTypeManifestation, isAnnotation, isInterface

Methods inherited from interface ModifierReviewable.OfAbstraction

isAbstract

Methods inherited from interface ModifierReviewable.OfByteCodeElement

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

Methods inherited from interface ModifierReviewable.OfEnumeration

getEnumerationState, isEnum

Methods inherited from interface NamedElement

getActualName

Methods inherited from interface NamedElement.WithDescriptor

getDescriptor, getGenericSignature

Methods inherited from interface NamedElement.WithRuntimeName

getInternalName

Methods inherited from interface TypeDefinition

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

Methods inherited from interface TypeDescription

asBoxed, asUnboxed, getActualModifiers, getCanonicalName, getClassFileVersion, getComponentType, getDefaultValue, getInheritedAnnotations, getInnerClassCount, getLongSimpleName, getSimpleName, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isCompileTimeConstant, isInHierarchyWith, isInHierarchyWith, isInnerClass, isInstance, isMemberType, isModuleType, isNestedClass, isNestHost, isNestMateOf, isNestMateOf, isPackageType, isPrimitiveWrapper, isSamePackage

Methods inherited from interface TypeVariableSource

accept, findExpectedVariable, findVariable, getEnclosingSource, isGenerified, isInferrable

Field Details

KEYWORDS

private static final Set<String> KEYWORDS

A set containing all keywords of the Java programming language.

name

private final String name

The binary name of the instrumented type.

modifiers

private final int modifiers

The modifiers of the instrumented type.

superClass

@MaybeNull
private final TypeDescription.Generic superClass

The generic super type of the instrumented type.

moduleDescription

@MaybeNull
private final ModuleDescription moduleDescription

The module metadata that this type implies or null.

typeVariables

private final List<? extends TypeVariableToken> typeVariables

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

interfaceTypes

private final List<? extends TypeDescription.Generic> interfaceTypes

A list of interfaces of the instrumented type.

fieldTokens

private final List<? extends FieldDescription.Token> fieldTokens

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

auxiliaryFields

private final Map<String,Object> auxiliaryFields

A mapping of auxiliary field names to their mapped values.

methodTokens

private final List<? extends MethodDescription.Token> methodTokens

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

recordComponentTokens

private final List<? extends RecordComponentDescription.Token> recordComponentTokens

A list of record component tokens describing the record components of the instrumented type.

annotationDescriptions

private final List<? extends AnnotationDescription> annotationDescriptions

A list of annotations of the annotated type.

typeInitializer

private final TypeInitializer typeInitializer

The type initializer of the instrumented type.

loadedTypeInitializer

private final LoadedTypeInitializer loadedTypeInitializer

The loaded type initializer of the instrumented type.

declaringType

@MaybeNull
private final TypeDescription declaringType

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

enclosingMethod

@MaybeNull
private final MethodDescription.InDefinedShape enclosingMethod

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

enclosingType

@MaybeNull
private final TypeDescription enclosingType

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

declaredTypes

private final List<? extends TypeDescription> declaredTypes

A list of types that are declared by this type.

permittedSubclasses

@MaybeNull
private final List<? extends TypeDescription> permittedSubclasses

A list of permitted subclasses or null if this type is not sealed.

anonymousClass

private final boolean anonymousClass

true if this type is an anonymous class.

localClass

private final boolean localClass

true if this type is a local class.

record

private final boolean record

true if this class is a record class.

nestHost

private final TypeDescription nestHost

The nest host of this instrumented type or a description of TargetType if this type is its own nest host.

nestMembers

private final List<? extends TypeDescription> nestMembers

A list of all members of this types nest group excluding this type.

Constructor Details

Default

protected Default(String name,
 int modifiers,
 @MaybeNull
 ModuleDescription moduleDescription,
 List<? extends TypeVariableToken> typeVariables,
 @MaybeNull
 TypeDescription.Generic superClass,
 List<? extends TypeDescription.Generic> interfaceTypes,
 List<? extends FieldDescription.Token> fieldTokens,
 Map<String,Object> auxiliaryFieldValues,
 List<? extends MethodDescription.Token> methodTokens,
 List<? extends RecordComponentDescription.Token> recordComponentTokens,
 List<? extends AnnotationDescription> annotationDescriptions,
 TypeInitializer typeInitializer,
 LoadedTypeInitializer loadedTypeInitializer,
 @MaybeNull
 TypeDescription declaringType,
 @MaybeNull
 MethodDescription.InDefinedShape enclosingMethod,
 @MaybeNull
 TypeDescription enclosingType,
 List<? extends TypeDescription> declaredTypes,
 @MaybeNull
 List<? extends TypeDescription> permittedSubclasses,
 boolean anonymousClass,
 boolean localClass,
 boolean record,
 TypeDescription nestHost,
 List<? extends TypeDescription> nestMembers)

Creates a new instrumented type.

Parameters:

name - The binary name of the instrumented type.

modifiers - The modifiers of the instrumented type.

moduleDescription - The module metadata that this type implies or null.

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.

auxiliaryFieldValues - A mapping of auxiliary field names to their mapped values.

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

recordComponentTokens - A list of record component tokens describing the record components 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.

permittedSubclasses - A list of permitted subclasses or null if this type is not sealed.

anonymousClass - true if this type is an anonymous class.

localClass - true if this type is a local class.

record - true if this type is a record class.

nestHost - The nest host of this instrumented type or a description of TargetType if this type is its own nest host.

nestMembers - A list of all members of this types nest group excluding this type.

Method Details

of

public static InstrumentedType of(String name,
 TypeDescription.Generic superClass,
 ModifierContributor.ForType... modifierContributor)

Creates a new instrumented type.

Parameters:

name - The type's name.

superClass - The type's super class.

modifierContributor - The type's modifiers.

Returns:

An appropriate instrumented type.

of

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

Creates a new instrumented type.

Parameters:

name - The type's name.

superClass - The type's super class.

modifiers - The type's modifiers.

Returns:

An appropriate instrumented type.

withModifiers

public InstrumentedType.WithFlexibleName withModifiers(int modifiers)

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)

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.

Returns:

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

withAuxiliaryField

public InstrumentedType.WithFlexibleName withAuxiliaryField(FieldDescription.Token token,
 Object value)

Creates a new instrumented type that includes a new field.

Specified by:

withAuxiliaryField in interface InstrumentedType

Specified by:

withAuxiliaryField in interface InstrumentedType.WithFlexibleName

Parameters:

token - A token that represents the field's shape.

value - The value that this assigned to this field.

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)

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.

Returns:

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

withRecordComponent

public InstrumentedType.WithFlexibleName withRecordComponent(RecordComponentDescription.Token token)

Creates a new instrumented type that includes a new record component.

Specified by:

withRecordComponent in interface InstrumentedType

Specified by:

withRecordComponent in interface InstrumentedType.WithFlexibleName

Parameters:

token - A token that represents the record component's shape.

Returns:

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

withInterfaces

public InstrumentedType.WithFlexibleName withInterfaces(TypeList.Generic interfaceTypes)

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)

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

withNestHost

public InstrumentedType.WithFlexibleName withNestHost(TypeDescription nestHost)

Creates a new instrumented type with the supplied nest host. An instrumented type can be its own nest host. Setting a nest host removes all nest members from the instrumented type.

Specified by:

withNestHost in interface InstrumentedType

Specified by:

withNestHost in interface InstrumentedType.WithFlexibleName

Parameters:

nestHost - The nest host of the created instrumented type.

Returns:

A new instrumented type with the supplied type as its nest host.

withNestMembers

public InstrumentedType.WithFlexibleName withNestMembers(TypeList nestMembers)

Creates a new instrumented types with the supplied nest members added to this instrumented type. The instrumented type is defined as a nest host if this method is invoked. Any previous nest members are prepended to the supplied types.

Specified by:

withNestMembers in interface InstrumentedType

Specified by:

withNestMembers in interface InstrumentedType.WithFlexibleName

Parameters:

nestMembers - The nest members to add to the created instrumented type.

Returns:

A new instrumented type that applies the supplied nest members.

withEnclosingType

public InstrumentedType.WithFlexibleName withEnclosingType(@MaybeNull
 TypeDescription enclosingType)

Creates a new instrumented type with the supplied enclosing type.

Specified by:

withEnclosingType in interface InstrumentedType

Specified by:

withEnclosingType in interface InstrumentedType.WithFlexibleName

Parameters:

enclosingType - The type to define as the created instrumented type's enclosing type.

Returns:

A new instrumented type with the supplied type as its enclosing type.

withEnclosingMethod

public InstrumentedType.WithFlexibleName withEnclosingMethod(MethodDescription.InDefinedShape enclosingMethod)

Creates a new instrumented type with the supplied enclosing method.

Specified by:

withEnclosingMethod in interface InstrumentedType

Specified by:

withEnclosingMethod in interface InstrumentedType.WithFlexibleName

Parameters:

enclosingMethod - The method to define as the created instrumented type's enclosing method.

Returns:

A new instrumented type with the supplied method as its enclosing method.

withDeclaringType

public InstrumentedType.WithFlexibleName withDeclaringType(@MaybeNull
 TypeDescription declaringType)

Creates a new instrumented type that is declared by the supplied type.

Specified by:

withDeclaringType in interface InstrumentedType

Specified by:

withDeclaringType in interface InstrumentedType.WithFlexibleName

Parameters:

declaringType - The type that declares the instrumented type or null if no such type exists.

Returns:

A new instrumented type that is declared by the instrumented type.

withDeclaredTypes

public InstrumentedType.WithFlexibleName withDeclaredTypes(TypeList declaredTypes)

Creates a new instrumented type that indicates that it declared the supplied types.

Specified by:

withDeclaredTypes in interface InstrumentedType

Specified by:

withDeclaredTypes in interface InstrumentedType.WithFlexibleName

Parameters:

declaredTypes - The types to add to the created instrumented type as declared types.

Returns:

A new instrumented type that indicates that it has declared the supplied types.

withPermittedSubclasses

public InstrumentedType.WithFlexibleName withPermittedSubclasses(@MaybeNull
 TypeList permittedSubclasses)

Creates a new instrumented type that includes the supplied permitted subclasses or unseals the type.

Specified by:

withPermittedSubclasses in interface InstrumentedType

Specified by:

withPermittedSubclasses in interface InstrumentedType.WithFlexibleName

Parameters:

permittedSubclasses - A list of permitted subclasses to include or null to unseal the type.

Returns:

A new instrumented type that includes the supplied permitted subclasses or unseals the type.

withModuleDescription

public InstrumentedType.WithFlexibleName withModuleDescription(@MaybeNull
 ModuleDescription moduleDescription)

Description copied from interface: InstrumentedType.WithFlexibleName

Creates a new instrumented type that defines the provided module metadata or no such metadata if null is provided.

Specified by:

withModuleDescription in interface InstrumentedType

Specified by:

withModuleDescription in interface InstrumentedType.WithFlexibleName

Parameters:

moduleDescription - The metadata to include or null.

Returns:

A new instrumented type that is equal to this instrumented type but with adjusted module metadata.

withTypeVariable

public InstrumentedType.WithFlexibleName withTypeVariable(TypeVariableToken typeVariable)

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)

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)

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.

withLocalClass

public InstrumentedType.WithFlexibleName withLocalClass(boolean localClass)

Creates a new instrumented type that indicates that is defined as a local class. Setting this property resets the anonymous class property.

Specified by:

withLocalClass in interface InstrumentedType

Specified by:

withLocalClass in interface InstrumentedType.WithFlexibleName

Parameters:

localClass - true if the instrumented type is supposed to be treated as a local class.

Returns:

A new instrumented type that is treated as a local class.

withAnonymousClass

public InstrumentedType.WithFlexibleName withAnonymousClass(boolean anonymousClass)

Creates a new instrumented type that indicates that it is defined as an anonymous class. Setting this property resets the local class property.

Specified by:

withAnonymousClass in interface InstrumentedType

Specified by:

withAnonymousClass in interface InstrumentedType.WithFlexibleName

Parameters:

anonymousClass - true if the instrumented type is supposed to be treated as an anonymous class.

Returns:

A new instrumented type that is treated as an anonymous class.

withRecord

public InstrumentedType.WithFlexibleName withRecord(boolean record)

Creates a new instrumented type that indicates that it defined as a record type. Setting this property to false removes all record components.

Specified by:

withRecord in interface InstrumentedType

Specified by:

withRecord in interface InstrumentedType.WithFlexibleName

Parameters:

record - true if the instrumented type is supposed to be a record.

Returns:

A new instrumented type that is defined as a record.

withInitializer

public InstrumentedType.WithFlexibleName withInitializer(LoadedTypeInitializer loadedTypeInitializer)

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)

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

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

Returns this instrumented type's type initializer.

Specified by:

getTypeInitializer in interface InstrumentedType

Returns:

This instrumented type's type initializer.

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.

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

@MaybeNull
public TypeDescription getEnclosingType()

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

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.

Specified by:

getDeclaredTypes in interface TypeDescription

Returns:

A list of types that are declared within this type.

isAnonymousType

public boolean isAnonymousType()

Checks if this type description represents an anonymous type.

Specified by:

isAnonymousType in interface TypeDescription

Returns:

true if this type description represents an anonymous type.

isLocalType

public boolean isLocalType()

Checks if this type description represents a local type.

Specified by:

isLocalType in interface TypeDescription

Returns:

true if this type description represents a local type.

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.

Specified by:

getPackage in interface TypeDescription

Returns:

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

toModuleDescription

@MaybeNull
public ModuleDescription toModuleDescription()

Returns a representation of a Java module that is represented by this type description, normally a module-info.class file. If there is no module meta-data attached to the current class, null is returned.

Specified by:

toModuleDescription in interface TypeDescription

Returns:

A description of the module information of this type or null if no such information is available.

getDeclaredAnnotations

public AnnotationList getDeclaredAnnotations()

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

Specified by:

getDeclaredAnnotations in interface AnnotationSource

Returns:

A list of declared annotations.

getDeclaringType

@MaybeNull
public TypeDescription getDeclaringType()

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

@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.

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

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

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

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

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

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

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.

Specified by:

getName in interface NamedElement.WithRuntimeName

Returns:

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

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.

Specified by:

getNestHost in interface TypeDescription

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.

Specified by:

getNestMembers in interface TypeDescription

Returns:

A list of members of this nest group.

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.

Specified by:

getRecordComponents in interface TypeDefinition

Specified by:

getRecordComponents in interface TypeDescription

Returns:

A list of record components that this type declares.

isRecord

public boolean isRecord()

Checks if this type is a Java record.

Specified by:

isRecord in interface TypeDefinition

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.

Specified by:

getPermittedSubtypes in interface TypeDescription

Returns:

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

validated

public TypeDescription validated()

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.

isValidIdentifier

private static boolean isValidIdentifier(String[] identifier)

Checks if an array of identifiers is a valid compound Java identifier.

Parameters:

identifier - an array of potentially invalid Java identifiers.

Returns:

true if all identifiers are valid and the array is not empty.

isValidIdentifier

private static boolean isValidIdentifier(String identifier)

Checks if a Java identifier is valid.

Parameters:

identifier - The identifier to check for validity.

Returns:

true if the given identifier is valid.

isValidUnqualifiedNameIdentifier

private static boolean isValidUnqualifiedNameIdentifier(String identifier)

Checks if an identifier is a valid "Unqualified Name" for a field, a local variable or a formal parameter, per JVMS 4.2.2.

Parameters:

identifier - The identifier to check for validity.

Returns:

true if the given identifier is valid.

isValidMethodIdentifier

private static boolean isValidMethodIdentifier(String identifier)

Checks if an identifier is a valid "Unqualified Name" for a method, per JVMS 4.2.2.

Parameters:

identifier - The identifier to check for validity.

Returns:

true if the given identifier is valid.