net.bytebuddy.description.type

Interface TypeDescription

All Superinterfaces:

AnnotatedCodeElement, ByteCodeElement, DeclaredByType, Iterable<TypeDefinition>, ModifierReviewable, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, NamedElement, NamedElement.WithRuntimeName, TypeDefinition, TypeVariableSource

All Known Subinterfaces:

InstrumentedType, InstrumentedType.WithFlexibleName

All Known Implementing Classes:

InstrumentedType.Default, TypeDescription.AbstractBase, TypeDescription.AbstractBase.OfSimpleType, TypeDescription.AbstractBase.OfSimpleType.WithDelegation, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.ForPackageDescription, TypeDescription.Latent, TypePool.Default.LazyTypeDescription, TypePool.Default.WithLazyResolution.LazyTypeDescription, TypePool.LazyFacade.LazyTypeDescription

public interface TypeDescription
extends TypeDefinition, ByteCodeElement, TypeVariableSource

Implementations of this interface represent a Java type, i.e. a class or interface. Instances of this interface always represent non-generic types of sort Generic.Sort#NON_GENERIC.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeDescription.AbstractBase An abstract base implementation of a type description.
static class	TypeDescription.ArrayProjection A projection for an array type based on an existing TypeDescription.
static class	TypeDescription.ForLoadedType A type description implementation that represents a loaded type.
static class	TypeDescription.ForPackageDescription A type representation of a package description.
static interface	TypeDescription.Generic Represents a generic type of the Java programming language.
static class	TypeDescription.Latent A latent type description for a type without methods or fields.

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

TypeDefinition.Sort, TypeDefinition.SuperClassIterator

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

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

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

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

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

NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

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

TypeVariableSource.Visitor<T>

Field Summary

Fields

Modifier and Type	Field and Description
static TypeList.Generic	ARRAY_INTERFACES A list of interfaces that are implicitly implemented by any array type.
static TypeDescription	CLASS A representation of the Class type.
static TypeDescription	OBJECT A representation of the Object type.
static TypeDescription	STRING A representation of the String type.
static TypeDescription	THROWABLE A representation of the Throwable type.
static TypeDescription	UNDEFINED Represents any undefined property representing a type description that is instead represented as null in order to resemble the Java reflection API which returns null and is intuitive to many Java developers.
static TypeDescription	VOID A representation of the void non-type.

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Fields inherited from interface net.bytebuddy.description.ByteCodeElement

NON_GENERIC_SIGNATURE

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME, NO_NAME

Method Summary

Modifier and Type	Method and Description
int	getActualModifiers(boolean superFlag) Returns the type's actual modifiers as present in the class file.
String	getCanonicalName() Returns the canonical name of this type if it exists.
TypeDescription	getComponentType() Returns the component type of this type.
FieldList<FieldDescription.InDefinedShape>	getDeclaredFields() Returns the fields that this type declares.
MethodList<MethodDescription.InDefinedShape>	getDeclaredMethods() Returns the methods that this type declares.
TypeList	getDeclaredTypes() Returns a list of types that are declared by this type excluding anonymous classes.
TypeDescription	getDeclaringType() Returns the declaring type of this instance.
MethodDescription	getEnclosingMethod() Returns a description of the method that encloses this type.
TypeDescription	getEnclosingType() Returns a description of this type's enclosing type if any.
AnnotationList	getInheritedAnnotations() Returns the annotations that this type declares or inherits from super types.
PackageDescription	getPackage() Returns the package internalName of the type described by this instance.
int	getSegmentCount() Returns the amount of outer classes this type defines.
String	getSimpleName() Returns the simple internalName of this type.
boolean	isAnnotationReturnType() Checks if instances of this type can be returned from an annotation method.
boolean	isAnnotationValue() Checks if instances of this type can be used for describing an annotation value.
boolean	isAnnotationValue(Object value) Checks if instances of this type can be used for describing the given annotation value.
boolean	isAnonymousClass() Checks if this type description represents an anonymous type.
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	isConstantPool() Checks if instances of this type can be stored in the constant pool of a class.
boolean	isInstance(Object value) Checks if value is an instance of the type represented by this instance.
boolean	isInstanceOrWrapper(Object value) Checks if value is an instance of the type represented by this instance or a wrapper instance of the corresponding primitive value.
boolean	isLocalClass() Checks if this type description represents a local type.
boolean	isMemberClass() Checks if this type description represents a member type.
boolean	isPackageType() Checks if this type represents a class that is a place holder for a package description.
boolean	isPrimitiveWrapper() Checks if this type represents a wrapper type for a primitive type.
boolean	isSamePackage(TypeDescription typeDescription) Checks if two types are defined in the same package.

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

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

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

isAnnotation, isInterface

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

isAbstract

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

isEnum

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

isDeprecated, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getModifiers, isFinal, isSynthetic

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface net.bytebuddy.description.ByteCodeElement

getDescriptor, getGenericSignature, isVisibleTo

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

getInternalName, getName

Methods inherited from interface net.bytebuddy.description.NamedElement

getActualName

Methods inherited from interface net.bytebuddy.description.annotation.AnnotatedCodeElement

getDeclaredAnnotations

Methods inherited from interface net.bytebuddy.description.TypeVariableSource

accept, findVariable, getEnclosingSource, getTypeVariables, isGenericDeclaration

Field Detail

OBJECT

static final TypeDescription OBJECT

A representation of the Object type.

STRING

static final TypeDescription STRING

A representation of the String type.

CLASS

static final TypeDescription CLASS

A representation of the Class type.

THROWABLE

static final TypeDescription THROWABLE

A representation of the Throwable type.

VOID

static final TypeDescription VOID

A representation of the void non-type.

ARRAY_INTERFACES

static final TypeList.Generic ARRAY_INTERFACES

A list of interfaces that are implicitly implemented by any array type.

UNDEFINED

static final TypeDescription UNDEFINED

Represents any undefined property representing a type description that is instead represented as null in order to resemble the Java reflection API which returns null and is intuitive to many Java developers.

Method Detail

getDeclaredFields

FieldList<FieldDescription.InDefinedShape> getDeclaredFields()

Description copied from interface: TypeDefinition

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

Specified by:

getDeclaredFields in interface TypeDefinition

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<MethodDescription.InDefinedShape> getDeclaredMethods()

Description copied from interface: TypeDefinition

Returns the methods that this type declares.

Specified by:

getDeclaredMethods in interface TypeDefinition

Returns:

The methods that this type declares.

isInstance

boolean isInstance(Object value)

Checks if value is an instance of the type represented by this instance.

Parameters:

value - The object of interest.

Returns:

true if the object is an instance of the type described by this instance.

isInstanceOrWrapper

boolean isInstanceOrWrapper(Object value)

Checks if value is an instance of the type represented by this instance or a wrapper instance of the corresponding primitive value.

Parameters:

value - The object of interest.

Returns:

true if the object is an instance or wrapper of the type described by this instance.

isAssignableFrom

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

Parameters:

type - The type of interest.

Returns:

true if this type is assignable from type.

isAssignableFrom

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

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

Parameters:

typeDescription - The type of interest.

Returns:

true if this type is assignable from type.

isAssignableTo

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

Parameters:

type - The type of interest.

Returns:

true if this type is assignable to type.

isAssignableTo

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

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

Parameters:

typeDescription - The type of interest.

Returns:

true if this type is assignable to type.

getComponentType

TypeDescription getComponentType()

Description copied from interface: TypeDefinition

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.

Specified by:

getComponentType in interface TypeDefinition

Returns:

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

getDeclaringType

TypeDescription getDeclaringType()

Description copied from interface: DeclaredByType

Returns the declaring type of this instance.

Specified by:

getDeclaringType in interface DeclaredByType

Returns:

The declaring type or null if no such type exists.

getDeclaredTypes

TypeList getDeclaredTypes()

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

Returns:

A list of types that are declared within this type.

getEnclosingMethod

MethodDescription 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

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.

getActualModifiers

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.

Parameters:

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

Returns:

The type's actual modifiers.

getSimpleName

String getSimpleName()

Returns the simple internalName of this type.

Returns:

The simple internalName of this type.

getCanonicalName

String getCanonicalName()

Returns the canonical name of this type if it exists.

Returns:

The canonical name of this type. Might be null.

isAnonymousClass

boolean isAnonymousClass()

Checks if this type description represents an anonymous type.

Returns:

true if this type description represents an anonymous type.

isLocalClass

boolean isLocalClass()

Checks if this type description represents a local type.

Returns:

true if this type description represents a local type.

isMemberClass

boolean isMemberClass()

Checks if this type description represents a member type.

Returns:

true if this type description represents a member type.

getPackage

PackageDescription getPackage()

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

Returns:

The package internalName of the type described by this instance.

getInheritedAnnotations

AnnotationList getInheritedAnnotations()

Returns the annotations that this type declares or inherits from super types.

Returns:

A list of all inherited annotations.

isSamePackage

boolean isSamePackage(TypeDescription typeDescription)

Checks if two types are defined in the same package.

Parameters:

typeDescription - The type of interest.

Returns:

true if this type and the given type are in the same package.

isConstantPool

boolean isConstantPool()

Checks if instances of this type can be stored in the constant pool of a class. Note that any primitive type that is smaller than an int cannot be stored in the constant pool as those types are represented as int values internally.

Returns:

true if instances of this type can be stored in the constant pool of a class.

isPrimitiveWrapper

boolean isPrimitiveWrapper()

Checks if this type represents a wrapper type for a primitive type. The Void type is not considered to be a wrapper type.

Returns:

true if this type represents a wrapper type.

isAnnotationReturnType

boolean isAnnotationReturnType()

Checks if instances of this type can be returned from an annotation method.

Returns:

true if instances of this type can be returned from an annotation method.

isAnnotationValue

boolean isAnnotationValue()

Checks if instances of this type can be used for describing an annotation value.

Returns:

true if instances of this type can be used for describing an annotation value.

isAnnotationValue

boolean isAnnotationValue(Object value)

Checks if instances of this type can be used for describing the given annotation value.

Parameters:

value - The value that is supposed to describe the annotation value for this instance.

Returns:

true if instances of this type can be used for describing the given annotation value..

isPackageType

boolean isPackageType()

Checks if this type represents a class that is a place holder for a package description.

Returns:

true if this type represents a package description.

getSegmentCount

int getSegmentCount()

Returns the amount of outer classes this type defines. If this type is not an inner type of another class, 0 is returned.

Returns:

The number of outer classes relatively to this type.