net.bytebuddy.description.type

Interface TypeDefinition

All Superinterfaces:

Iterable<TypeDefinition>, ModifierReviewable, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, NamedElement

All Known Subinterfaces:

InstrumentedType, InstrumentedType.WithFlexibleName, TypeDescription, TypeDescription.Generic

All Known Implementing Classes:

InstrumentedType.Default, TypeDescription.AbstractBase, TypeDescription.AbstractBase.OfSimpleType, TypeDescription.AbstractBase.OfSimpleType.WithDelegation, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.ForPackageDescription, TypeDescription.Generic.AbstractBase, TypeDescription.Generic.LazyProjection, TypeDescription.Generic.LazyProjection.ForLoadedFieldType, TypeDescription.Generic.LazyProjection.ForLoadedReturnType, TypeDescription.Generic.LazyProjection.ForLoadedSuperClass, TypeDescription.Generic.LazyProjection.OfAnnotatedElement, TypeDescription.Generic.LazyProjection.OfConstructorParameter, TypeDescription.Generic.LazyProjection.OfMethodParameter, TypeDescription.Generic.OfGenericArray, TypeDescription.Generic.OfGenericArray.ForLoadedType, TypeDescription.Generic.OfGenericArray.Latent, TypeDescription.Generic.OfNonGenericType, TypeDescription.Generic.OfNonGenericType.ForLoadedType, TypeDescription.Generic.OfNonGenericType.Latent, TypeDescription.Generic.OfNonGenericType.OfErasure, TypeDescription.Generic.OfParameterizedType, TypeDescription.Generic.OfParameterizedType.ForGenerifiedErasure, TypeDescription.Generic.OfParameterizedType.ForLoadedType, TypeDescription.Generic.OfParameterizedType.Latent, TypeDescription.Generic.OfTypeVariable, TypeDescription.Generic.OfTypeVariable.ForLoadedType, TypeDescription.Generic.OfTypeVariable.Symbolic, TypeDescription.Generic.OfTypeVariable.WithAnnotationOverlay, TypeDescription.Generic.OfWildcardType, TypeDescription.Generic.OfWildcardType.ForLoadedType, TypeDescription.Generic.OfWildcardType.Latent, TypeDescription.Generic.Visitor.AnnotationStripper.NonAnnotatedTypeVariable, TypeDescription.Generic.Visitor.Substitutor.ForTypeVariableBinding.RetainedMethodTypeVariable, TypeDescription.Generic.Visitor.TypeVariableErasing.RetainedTypeVariable, TypeDescription.Latent, TypeList.Generic.ForDetachedTypes.OfTypeVariables.AttachedTypeVariable, TypePool.Default.LazyTypeDescription, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForGenericArray.LazyGenericArray, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForLowerBoundWildcard.LazyLowerBoundWildcard, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForParameterizedType.LazyParameterizedType, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForParameterizedType.Nested.LazyParameterizedType, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForPrimitiveType.LazyPrimitiveType, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForTypeVariable.AnnotatedTypeVariable, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForTypeVariable.Formal.LazyTypeVariable, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForUnboundWildcard.LazyUnboundWildcard, TypePool.Default.LazyTypeDescription.GenericTypeToken.ForUpperBoundWildcard.LazyUpperBoundWildcard, TypePool.Default.LazyTypeDescription.GenericTypeToken.Resolution.Raw.RawAnnotatedType, TypePool.Default.WithLazyResolution.LazyTypeDescription, TypePool.LazyFacade.LazyTypeDescription

public interface TypeDefinition
extends NamedElement, ModifierReviewable.ForTypeDefinition, Iterable<TypeDefinition>

Implementations define a type, either as a TypeDescription or as a TypeDescription.Generic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeDefinition.Sort Represents a TypeDescription.Generic's form.
static class	TypeDefinition.SuperClassIterator An iterator that iterates over a type's class hierarchy.

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

NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

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

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

Field Summary

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME, NO_NAME

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Method Summary

Modifier and Type	Method and Description
TypeDescription	asErasure() Returns the erasure of this type.
TypeDescription.Generic	asGenericType() Returns this type definition as a generic type.
TypeDefinition	getComponentType() Returns the component type of this type.
FieldList<?>	getDeclaredFields() Returns the fields that this type declares.
MethodList<?>	getDeclaredMethods() Returns the methods that this type declares.
TypeList.Generic	getInterfaces() Returns the interfaces that this type implements.
TypeDefinition.Sort	getSort() Returns the sort of the generic type this instance represents.
StackSize	getStackSize() Returns the size of the type described by this instance.
TypeDescription.Generic	getSuperClass() Returns the super class of this type.
String	getTypeName() Returns the name of the type.
boolean	isArray() Checks if the type described by this entity is an array.
boolean	isPrimitive() Checks if the type described by this entity is a primitive type.
boolean	represents(Type type) Checks if the type described by this instance represents type.

Methods inherited from interface net.bytebuddy.description.NamedElement

getActualName

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

isAnnotation, isInterface

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

isAbstract

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

isEnum

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

isDeprecated, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getModifiers, isFinal, isSynthetic

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

asGenericType

TypeDescription.Generic asGenericType()

Returns this type definition as a generic type.

Returns:

This type definition represented as a generic type.

asErasure

TypeDescription asErasure()

Returns the erasure of this type. Wildcard types (TypeDescription.Generic.Sort#WILDCARD) do not have a well-defined erasure and cause an IllegalStateException to be thrown.

Returns:

The erasure of this type.

getSuperClass

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

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.

getDeclaredFields

FieldList<?> 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

MethodList<?> getDeclaredMethods()

Returns the methods that this type declares.

Returns:

The methods that this type declares.

getComponentType

TypeDefinition getComponentType()

Returns the component type of this type.

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

Returns:

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

getSort

TypeDefinition.Sort getSort()

Returns the sort of the generic type this instance represents.

Returns:

The sort of the generic type.

getTypeName

String getTypeName()

Returns the name of the type. For generic types, this name is their Object.toString() representations. For a non-generic type, it is the fully qualified binary name of the type.

Returns:

The name of this type.

getStackSize

StackSize getStackSize()

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

Returns:

The size of the type described by this instance.

isArray

boolean isArray()

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

Returns:

true if this type description represents an array.

isPrimitive

boolean isPrimitive()

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

Returns:

true if this type description represents a primitive type.

represents

boolean represents(Type type)

Checks if the type described by this instance represents type.

Parameters:

type - The type of interest.

Returns:

true if the type described by this instance represents type.