TypeDescription (Byte Buddy (with dependencies) 0.5 API)

All Superinterfaces:

AnnotatedElement, 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, 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.

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

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.
`String`	`getGenericSignature()` Returns the generic signature of this type or `null` if no such signature is available.
`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`	`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`	`isInstance(Object object)` Checks if `object` is an instance of the type represented by this instance.
`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`	`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.instrumentation.ByteCodeElement
getDescriptor, getInternalName, getSourceCodeName, isVisibleTo

Methods inherited from interface net.bytebuddy.instrumentation.NamedElement
getName

Methods inherited from interface net.bytebuddy.instrumentation.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.instrumentation.type.DeclaredInType
getDeclaringType

Methods inherited from interface net.bytebuddy.instrumentation.attribute.annotation.AnnotatedElement
getDeclaredAnnotations

- Method Detail
  - isInstance
```
boolean isInstance(Object object)
```
    Checks if object is an instance of the type represented by this instance.
    
    Parameters:
    
    object - The object of interest.
    
    Returns:
    
    true if the object is an instance 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.
  - getGenericSignature
```
String getGenericSignature()
```
    Returns the generic signature of this type or null if no such signature is available.
    
    Note: Loaded classes do currently not provide such a signature.
    
    Specified by:
    
    getGenericSignature in interface ByteCodeElement
    
    Returns:
    
    The generic signature of this type or null if no such signature is available.
  - 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.

Interface TypeDescription

Nested Class Summary

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

Method Summary

Methods inherited from interface net.bytebuddy.instrumentation.ByteCodeElement

Methods inherited from interface net.bytebuddy.instrumentation.NamedElement

Methods inherited from interface net.bytebuddy.instrumentation.ModifierReviewable

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

Methods inherited from interface net.bytebuddy.instrumentation.attribute.annotation.AnnotatedElement

Method Detail

isInstance

isAssignableFrom

isAssignableFrom

isAssignableTo

isAssignableTo

represents

isArray

getComponentType

isPrimitive

getSupertype

getInterfaces

getInheritedInterfaces

getEnclosingMethod

getEnclosingType

getActualModifiers

getSimpleName

getCanonicalName

getGenericSignature

isAnonymousClass

isLocalClass

isMemberClass

getDeclaredFields

getDeclaredMethods

getPackage

getStackSize

getInheritedAnnotations

isSamePackage