Class TypeDescription.ForLoadedType

java.lang.Object

net.bytebuddy.description.ModifierReviewable.AbstractBase

net.bytebuddy.description.TypeVariableSource.AbstractBase

net.bytebuddy.description.type.TypeDescription.AbstractBase

net.bytebuddy.description.type.TypeDescription.ForLoadedType

All Implemented Interfaces:

Serializable, 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

Enclosing interface:

TypeDescription

public static class TypeDescription.ForLoadedType
extends TypeDescription.AbstractBase
implements Serializable

A type description implementation that represents a loaded type.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	TypeDescription.ForLoadedType.Dispatcher	A dispatcher for using methods of Class that are not declared for Java 6.

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 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 static final TypeDescription.ForLoadedType.Dispatcher	DISPATCHER	A dispatcher for invking methods on Class reflectively.
private static final long	serialVersionUID	The class's serial version UID.
private final Class<?>	type	The loaded type this instance represents.
private static final Map<Class<?>, TypeDescription>	TYPE_CACHE	A cache of type descriptions for commonly used types to avoid unnecessary allocations.

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

Constructor	Description
ForLoadedType(Class<?> type)	Creates a new immutable type description for a loaded type.

Method Summary

Modifier and Type	Method	Description
TypeDescription.Generic	asGenericType()	Returns this type definition as a generic type.
private static <T> T	doPrivileged(PrivilegedAction<T> action)	A proxy for java.security.AccessController#doPrivileged that is activated if available.
String	getCanonicalName()	Returns the canonical name of this type if it exists.
ClassFileVersion	getClassFileVersion()	Attempts to resolve the class file version of this type.
TypeDescription	getComponentType()	Returns the component type 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.
String	getDescriptor()	Returns the descriptor of this byte code element.
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.
int	getModifiers()	Returns the modifier that is described by this object.
String	getName()	Returns the binary name of this byte code element.
static String	getName(Class<?> type)	Returns the type's actual name where it is taken into consideration that this type might be loaded anonymously.
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.
String	getSimpleName()	Returns the simple name of this type.
StackSize	getStackSize()	Returns the size of the type described by this instance.
TypeDescription.Generic	getSuperClass()	Returns the super class of this type.
TypeList.Generic	getTypeVariables()	Returns the type variables that are declared by this element.
boolean	isAnnotation()	Specifies if the modifier described by this object represents the annotation flag.
boolean	isAnonymousType()	Checks if this type description represents an anonymous type.
boolean	isArray()	Checks if the type described by this entity is an array.
boolean	isAssignableFrom(Class<?> type)	Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Foo.class.isAssignableFrom(Bar.class).
boolean	isAssignableFrom(TypeDescription typeDescription)	Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Foo.class.isAssignableFrom(Bar.class).
boolean	isAssignableTo(Class<?> type)	Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Bar.class.isAssignableTo(Foo.class).
boolean	isAssignableTo(TypeDescription typeDescription)	Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Bar.class.isAssignableFrom(Foo.class).
boolean	isInHierarchyWith(Class<?> type)	Returns true if this type and the supplied type are in a type hierarchy with each other, i.e.
boolean	isInHierarchyWith(TypeDescription typeDescription)	Returns true if this type and the supplied type are in a type hierarchy with each other, i.e.
boolean	isLocalType()	Checks if this type description represents a local type.
boolean	isMemberType()	Checks if this type description represents a member type.
boolean	isNestHost()	Checks if this class is the host of a nest group.
boolean	isNestMateOf(Class<?> type)	Checks if this type and the supplied type are members of the same nest group.
boolean	isNestMateOf(TypeDescription typeDescription)	Checks if this type and the supplied type are members of the same nest group.
boolean	isPrimitive()	Checks if the type described by this entity is a primitive 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.
static TypeDescription	of(Class<?> type)	Returns a new immutable type description for a loaded type.
boolean	represents(Type type)	Checks if the type described by this instance represents type.
ModuleDescription	toModuleDescription()	Returns a representation of a Java module that is represented by this type description, normally a module-info.class file.

Methods inherited from class TypeDescription.AbstractBase

accept, asBoxed, asErasure, asUnboxed, equals, getActualModifiers, getActualName, getDefaultValue, getEnclosingSource, getGenericSignature, getInheritedAnnotations, getInnerClassCount, getInternalName, getLongSimpleName, getSort, getTypeName, hashCode, isAccessibleTo, isAnnotationReturnType, isAnnotationValue, isAnnotationValue, isCompileTimeConstant, isGenerified, isInferrable, isInnerClass, isInstance, isModuleType, isNestedClass, isPackageType, isPrimitiveWrapper, isSamePackage, isVisibleTo, iterator, 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, 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 Iterable

forEach, spliterator

Methods inherited from interface ModifierReviewable

getSyntheticState, isFinal, isSynthetic

Methods inherited from interface ModifierReviewable.ForTypeDefinition

getTypeManifestation, 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 TypeVariableSource

findExpectedVariable, findVariable

Field Details

serialVersionUID

private static final long serialVersionUID

The class's serial version UID.

See Also:

• Constant Field Values

DISPATCHER

private static final TypeDescription.ForLoadedType.Dispatcher DISPATCHER

A dispatcher for invking methods on Class reflectively.

TYPE_CACHE

private static final Map<Class<?>, TypeDescription> TYPE_CACHE

A cache of type descriptions for commonly used types to avoid unnecessary allocations.

type

private final Class<?> type

The loaded type this instance represents.

Constructor Details

ForLoadedType

public ForLoadedType(Class<?> type)

Creates a new immutable type description for a loaded type. This constructor should not normally be used. Use of(Class) instead.

Parameters:

type - The type to be represented by this type description.

Method Details

doPrivileged

@Enhance
private static <T> T doPrivileged(PrivilegedAction<T> action)

A proxy for java.security.AccessController#doPrivileged that is activated if available.

Type Parameters:

T - The type of the action's resolved value.

Parameters:

action - The action to execute from a privileged context.

Returns:

The action's resolved value.

getName

public static String getName(Class<?> type)

Returns the type's actual name where it is taken into consideration that this type might be loaded anonymously. In this case, the remainder of the types name is suffixed by /<id> which is removed when using this method but is retained when calling Class.getName().

Parameters:

type - The type for which to resolve its name.

Returns:

The type's actual name.

of

public static TypeDescription of(Class<?> type)

Returns a new immutable type description for a loaded type.

Parameters:

type - The type to be represented by this type description.

Returns:

The type description representing the given type.

isAssignableFrom

public boolean isAssignableFrom(Class<?> type)

Description copied from class: TypeDescription.AbstractBase

Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Foo.class.isAssignableFrom(Bar.class).

Specified by:

isAssignableFrom in interface TypeDescription

Overrides:

isAssignableFrom in class TypeDescription.AbstractBase

Parameters:

type - The type of interest.

Returns:

true if this type is assignable from type.

isAssignableFrom

public boolean isAssignableFrom(TypeDescription typeDescription)

Description copied from class: TypeDescription.AbstractBase

Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Foo.class.isAssignableFrom(Bar.class).

Implementations of this methods are allowed to delegate to TypeDescription.isAssignableFrom(Class)

Specified by:

isAssignableFrom in interface TypeDescription

Overrides:

isAssignableFrom in class TypeDescription.AbstractBase

Parameters:

typeDescription - The type of interest.

Returns:

true if this type is assignable from type.

isAssignableTo

public boolean isAssignableTo(Class<?> type)

Description copied from class: TypeDescription.AbstractBase

Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Bar.class.isAssignableTo(Foo.class).

Specified by:

isAssignableTo in interface TypeDescription

Overrides:

isAssignableTo in class TypeDescription.AbstractBase

Parameters:

type - The type of interest.

Returns:

true if this type is assignable to type.

isAssignableTo

public boolean isAssignableTo(TypeDescription typeDescription)

Description copied from class: TypeDescription.AbstractBase

Checks if this type is assignable from the type described by this instance, for example for class Foo and class Bar extends Foo, this method would return true for Bar.class.isAssignableFrom(Foo.class).

Implementations of this methods are allowed to delegate to TypeDescription.isAssignableTo(Class)

Specified by:

isAssignableTo in interface TypeDescription

Overrides:

isAssignableTo in class TypeDescription.AbstractBase

Parameters:

typeDescription - The type of interest.

Returns:

true if this type is assignable to type.

isInHierarchyWith

public boolean isInHierarchyWith(Class<?> type)

Description copied from class: TypeDescription.AbstractBase

Returns true if this type and the supplied type are in a type hierarchy with each other, i.e. if this type is assignable to the supplied type or the other way around.

Specified by:

isInHierarchyWith in interface TypeDescription

Overrides:

isInHierarchyWith in class TypeDescription.AbstractBase

Parameters:

type - The type of interest.

Returns:

true if this type and the supplied type are in a type hierarchy with each other.

isInHierarchyWith

public boolean isInHierarchyWith(TypeDescription typeDescription)

Description copied from class: TypeDescription.AbstractBase

Returns true if this type and the supplied type are in a type hierarchy with each other, i.e. if this type is assignable to the supplied type or the other way around.

Specified by:

isInHierarchyWith in interface TypeDescription

Overrides:

isInHierarchyWith in class TypeDescription.AbstractBase

Parameters:

typeDescription - The type of interest.

Returns:

true if this type and the supplied type are in a type hierarchy with each other.

represents

public boolean represents(Type type)

Description copied from class: TypeDescription.AbstractBase

Checks if the type described by this instance represents type.

Specified by:

represents in interface TypeDefinition

Overrides:

represents in class TypeDescription.AbstractBase

Parameters:

type - The type of interest.

Returns:

true if the type described by this instance represents type.

getComponentType

@MaybeNull
public TypeDescription getComponentType()

Returns the component type of this type.

Only non-generic types (TypeDefinition.Sort.NON_GENERIC) and generic array types TypeDefinition.Sort.GENERIC_ARRAY) define a component type. For other types, an IllegalStateException is thrown.

Specified by:

getComponentType in interface TypeDefinition

Specified by:

getComponentType in interface TypeDescription

Returns:

The component type of this type or null if this type does not represent an array type.

isArray

public boolean isArray()

Checks if the type described by this entity is an array.

Specified by:

isArray in interface TypeDefinition

Returns:

true if this type description represents an array.

isPrimitive

public boolean isPrimitive()

Checks if the type described by this entity is a primitive type.

Specified by:

isPrimitive in interface TypeDefinition

Returns:

true if this type description represents a primitive type.

isAnnotation

public boolean isAnnotation()

Description copied from class: ModifierReviewable.AbstractBase

Specifies if the modifier described by this object represents the annotation flag.

Specified by:

isAnnotation in interface ModifierReviewable.ForTypeDefinition

Overrides:

isAnnotation in class ModifierReviewable.AbstractBase

Returns:

true if the modifier described by this object represents the annotation flag.

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.

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.

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

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.

getSimpleName

public String getSimpleName()

Returns the simple name of this type.

Specified by:

getSimpleName in interface TypeDescription

Returns:

The simple name of 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.

isMemberType

public boolean isMemberType()

Description copied from class: TypeDescription.AbstractBase

Checks if this type description represents a member type.

Specified by:

isMemberType in interface TypeDescription

Overrides:

isMemberType in class TypeDescription.AbstractBase

Returns:

true if this type description represents a member type.

getDeclaredFields

@Enhance("declaredFields")
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

@Enhance("declaredMethods")
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.

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.

getStackSize

public StackSize getStackSize()

Returns the size of the type described by this instance. Wildcard types (TypeDefinition.Sort.WILDCARD do not have a well-defined a stack size and cause an IllegalStateException to be thrown.

Specified by:

getStackSize in interface TypeDefinition

Returns:

The size of the type described by this instance.

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.

getCanonicalName

@MaybeNull
public String getCanonicalName()

Returns the canonical name of this type if it exists.

Specified by:

getCanonicalName in interface TypeDescription

Returns:

The canonical name of this type. Might be null.

getDescriptor

public String getDescriptor()

Returns the descriptor of this byte code element.

Specified by:

getDescriptor in interface NamedElement.WithDescriptor

Returns:

The descriptor of this byte code 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.

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.

getDeclaredAnnotations

@Enhance("declaredAnnotations")
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.

asGenericType

public TypeDescription.Generic asGenericType()

Returns this type definition as a generic type.

Specified by:

asGenericType in interface TypeDefinition

Overrides:

asGenericType in class TypeDescription.AbstractBase

Returns:

This type definition represented as a generic type.

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.

isNestHost

public boolean isNestHost()

Description copied from class: TypeDescription.AbstractBase

Checks if this class is the host of a nest group.

Specified by:

isNestHost in interface TypeDescription

Overrides:

isNestHost in class TypeDescription.AbstractBase

Returns:

true if this class is a nest group's host.

isNestMateOf

public boolean isNestMateOf(Class<?> type)

Description copied from class: TypeDescription.AbstractBase

Checks if this type and the supplied type are members of the same nest group.

Specified by:

isNestMateOf in interface TypeDescription

Overrides:

isNestMateOf in class TypeDescription.AbstractBase

Parameters:

type - The type for which to check if it is a member of the same nest group.

Returns:

true if this type and the supplied type are members of the same nest group.

isNestMateOf

public boolean isNestMateOf(TypeDescription typeDescription)

Description copied from class: TypeDescription.AbstractBase

Checks if this type and the supplied type are members of the same nest group.

Specified by:

isNestMateOf in interface TypeDescription

Overrides:

isNestMateOf in class TypeDescription.AbstractBase

Parameters:

typeDescription - The type for which to check if it is a member of the same nest group.

Returns:

true if this type and the supplied type are members of the same 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.

getClassFileVersion

@MaybeNull
@Enhance("classFileVersion")
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.