TypeDescription (Byte Buddy (with dependencies) 0.6.8 API)

All Superinterfaces:

AnnotatedCodeElement, ByteCodeElement, DeclaredInType, ModifierReviewable, NamedElement

All Known Subinterfaces:

InstrumentedType

All Known Implementing Classes:

InlineInstrumentedType, InstrumentedType.AbstractBase, SubclassInstrumentedType, TypeDescription.AbstractTypeDescription, TypeDescription.AbstractTypeDescription.OfSimpleType, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.Latent, TypePool.LazyTypeDescription
```
public interface TypeDescription
extends ByteCodeElement
```
Implementations of this interface represent a Java type, i.e. a class or interface.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TypeDescription.AbstractTypeDescription` 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.Latent` A latent type description for a type without methods or fields.

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

Field Summary

Fields
Modifier and Type	Field and Description
`static TypeDescription`	`CLASS` A representation of the `Class` type.
`static TypeDescription`	`ENUM` A representation of the `Enum` type.
`static TypeDescription`	`OBJECT` A representation of the `Object` type.
`static TypeDescription`	`STRING` A representation of the `String` type.
`static TypeDescription`	`VOID` A representation of the `void` non-type.

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

Fields inherited from interface net.bytebuddy.description.ModifierReviewable
EMPTY_MASK

Method Summary

All Methods Instance Methods Abstract Methods
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 internalName of this type.
`TypeDescription`	`getComponentType()` Returns the component type of this type.
`FieldList`	`getDeclaredFields()` Returns a list of fields that are declared by this type.
`MethodList`	`getDeclaredMethods()` Returns a list of methods that are declared by this type.
`MethodDescription`	`getEnclosingMethod()` Returns a description of the enclosing method of this type.
`TypeDescription`	`getEnclosingType()` Returns a description of the enclosing type of this type.
`AnnotationList`	`getInheritedAnnotations()` Returns the annotations that this type declares or inherits from super types.
`TypeList`	`getInheritedInterfaces()` Returns all interfaces that are implemented by this type, either directly or indirectly.
`TypeList`	`getInterfaces()` Returns a list of interfaces that are implemented by this type.
`PackageDescription`	`getPackage()` Returns the package internalName of the type described by this instance.
`String`	`getSimpleName()` Returns the simple internalName of this type.
`StackSize`	`getStackSize()` Returns the size of the type described by this instance.
`TypeDescription`	`getSupertype()` Returns the component type 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`	`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`	`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`	`isPrimitive()` Checks if the type described by this entity is a primitive type.
`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.
`boolean`	`represents(Class<?> type)` Checks if the type described by this instance represents `type`.

Methods inherited from interface net.bytebuddy.description.ByteCodeElement
getDescriptor, getGenericSignature, isVisibleTo

Methods inherited from interface net.bytebuddy.description.NamedElement
getInternalName, getName, getSourceCodeName

Methods inherited from interface net.bytebuddy.description.ModifierReviewable
getModifiers, isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Methods inherited from interface net.bytebuddy.description.type.DeclaredInType
getDeclaringType

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

- 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.
  - VOID
```
static final TypeDescription VOID
```
    A representation of the void non-type.
  - ENUM
```
static final TypeDescription ENUM
```
    A representation of the Enum type.
- Method Detail
  - 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.
  - represents
```
boolean represents(Class<?> 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.
  - isArray
```
boolean isArray()
```
    Checks if the type described by this entity is an array.
    
    Returns:
    
    true if this type description represents an array.
  - getComponentType
```
TypeDescription getComponentType()
```
    Returns the component type of this type.
    
    Returns:
    
    The component type of this array or null if this type description does not represent 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.
  - getSupertype
```
TypeDescription getSupertype()
```
    Returns the component type of this type.
    
    Returns:
    
    The component type of this array or null if type does not have a super type as for the Object type.
  - getInterfaces
```
TypeList getInterfaces()
```
    Returns a list of interfaces that are implemented by this type.
    
    Returns:
    
    A list of interfaces that are implemented by this type.
  - getInheritedInterfaces
```
TypeList getInheritedInterfaces()
```
    Returns all interfaces that are implemented by this type, either directly or indirectly.
    
    Returns:
    
    A list of all interfaces of this type in random order.
  - getEnclosingMethod
```
MethodDescription getEnclosingMethod()
```
    Returns a description of the enclosing method of this type.
    
    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 the enclosing type of this type.
    
    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.
    
    Unfortunately, the modifier for marking a static class collides with the SUPER modifier such that these flags are indistinguishable. Therefore, the flag must be specified manually.
    
    Parameters:
    
    superFlag - true if the 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 internalName of this type.
    
    Returns:
    
    The canonical internalName of this type.
  - 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.
  - getDeclaredFields
```
FieldList getDeclaredFields()
```
    Returns a list of fields that are declared by this type.
    
    Returns:
    
    A list of fields that are declared by this type.
  - getDeclaredMethods
```
MethodList getDeclaredMethods()
```
    Returns a list of methods that are declared by this type.
    
    Returns:
    
    A list of methods that are declared by this 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.
  - getStackSize
```
StackSize getStackSize()
```
    Returns the size of the type described by this instance.
    
    Returns:
    
    The size 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..

Interface TypeDescription

Nested Class Summary

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

Field Summary

Fields inherited from interface net.bytebuddy.description.NamedElement

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

Method Summary

Methods inherited from interface net.bytebuddy.description.ByteCodeElement

Methods inherited from interface net.bytebuddy.description.NamedElement

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

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

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

Field Detail

OBJECT

STRING

CLASS

VOID

ENUM

Method Detail

isInstance

isInstanceOrWrapper

isAssignableFrom

isAssignableFrom

isAssignableTo

isAssignableTo

represents

isArray

getComponentType

isPrimitive

getSupertype

getInterfaces

getInheritedInterfaces

getEnclosingMethod

getEnclosingType

getActualModifiers

getSimpleName

getCanonicalName

isAnonymousClass

isLocalClass

isMemberClass

getDeclaredFields

getDeclaredMethods

getPackage

getStackSize

getInheritedAnnotations

isSamePackage

isConstantPool

isPrimitiveWrapper

isAnnotationReturnType

isAnnotationValue

isAnnotationValue