net.bytebuddy.description.type

Class TypeDescription.AbstractTypeDescription

java.lang.Object

net.bytebuddy.description.ModifierReviewable.AbstractModifierReviewable

net.bytebuddy.description.type.TypeDescription.AbstractTypeDescription

All Implemented Interfaces:

AnnotatedCodeElement, ByteCodeElement, ModifierReviewable, NamedElement, DeclaredInType, TypeDescription

Direct Known Subclasses:

TypeDescription.AbstractTypeDescription.OfSimpleType, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType

Enclosing interface:

TypeDescription

public abstract static class TypeDescription.AbstractTypeDescription
extends ModifierReviewable.AbstractModifierReviewable
implements TypeDescription

An abstract base implementation of a type description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeDescription.AbstractTypeDescription.OfSimpleType An adapter implementation of a TypeDescription that describes any type that is not an array or a primitive type.

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

TypeDescription.AbstractTypeDescription, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.Latent

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

ModifierReviewable.AbstractModifierReviewable

Field Summary

Fields inherited from interface net.bytebuddy.description.type.TypeDescription

CLASS, ENUM, OBJECT, STRING, VOID

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Constructor Summary

Constructors

Constructor and Description
AbstractTypeDescription()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
int	getActualModifiers(boolean superFlag) Returns the type's actual modifiers as present in the class file.
String	getGenericSignature() Returns the generic signature of this byte code element.
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.
String	getInternalName() Returns the internal internalName of this byte code element.
protected String	getPackageName() Returns the name of this type's package.
String	getSourceCodeName() Returns the name of this byte code element as it is defined in Java source code.
int	hashCode()
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	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	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	isVisibleTo(TypeDescription typeDescription) Checks if this element is visible from a given type.
String	toString()

Methods inherited from class net.bytebuddy.description.ModifierReviewable.AbstractModifierReviewable

isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getCanonicalName, getComponentType, getDeclaredFields, getDeclaredMethods, getEnclosingMethod, getEnclosingType, getInterfaces, getPackage, getSimpleName, getStackSize, getSupertype, isAnonymousClass, isArray, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isLocalClass, isMemberClass, isPrimitive, represents

Methods inherited from interface net.bytebuddy.description.ByteCodeElement

getDescriptor

Methods inherited from interface net.bytebuddy.description.NamedElement

getName

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

Constructor Detail

AbstractTypeDescription

public AbstractTypeDescription()

Method Detail

isInstance

public boolean isInstance(Object value)

Description copied from interface: TypeDescription

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

Specified by:

isInstance in interface TypeDescription

Parameters:

value - The object of interest.

Returns:

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

isInstanceOrWrapper

public boolean isInstanceOrWrapper(Object value)

Description copied from interface: TypeDescription

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

Specified by:

isInstanceOrWrapper in interface TypeDescription

Parameters:

value - The object of interest.

Returns:

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

isAnnotationValue

public boolean isAnnotationValue(Object value)

Description copied from interface: TypeDescription

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

Specified by:

isAnnotationValue in interface TypeDescription

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

getInternalName

public String getInternalName()

Description copied from interface: NamedElement

Returns the internal internalName of this byte code element.

Specified by:

getInternalName in interface NamedElement

Returns:

The internal internalName of this byte code element as used within the Java class file format.

getActualModifiers

public int getActualModifiers(boolean superFlag)

Description copied from interface: TypeDescription

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.

Specified by:

getActualModifiers in interface TypeDescription

Parameters:

superFlag - true if the super flag should be set.

Returns:

The type's actual modifiers.

getGenericSignature

public String getGenericSignature()

Description copied from interface: ByteCodeElement

Returns the generic signature of this byte code element.

Specified by:

getGenericSignature in interface ByteCodeElement

Returns:

The generic signature or null if this element is not generic.

isSamePackage

public boolean isSamePackage(TypeDescription typeDescription)

Description copied from interface: TypeDescription

Checks if two types are defined in the same package.

Specified by:

isSamePackage in interface TypeDescription

Parameters:

typeDescription - The type of interest.

Returns:

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

isVisibleTo

public boolean isVisibleTo(TypeDescription typeDescription)

Description copied from interface: ByteCodeElement

Checks if this element is visible from a given type. Methods are only considered visible if their return type and their parameter types are also visible to the given type. Similarly, fields are only considered visible if the field's type is visible to the given type. For array types, a type is considered visible only if the component type is visible to the given type.

Specified by:

isVisibleTo in interface ByteCodeElement

Parameters:

typeDescription - The type which is checked for its access of this element.

Returns:

true if this element is visible for typeDescription.

getInheritedInterfaces

public TypeList getInheritedInterfaces()

Description copied from interface: TypeDescription

Returns all interfaces that are implemented by this type, either directly or indirectly.

Specified by:

getInheritedInterfaces in interface TypeDescription

Returns:

A list of all interfaces of this type in random order.

getInheritedAnnotations

public AnnotationList getInheritedAnnotations()

Description copied from interface: TypeDescription

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

Specified by:

getInheritedAnnotations in interface TypeDescription

Returns:

A list of all inherited annotations.

getSourceCodeName

public String getSourceCodeName()

Description copied from interface: NamedElement

Returns the name of this byte code element as it is defined in Java source code. This means:

• For type descriptions, the main distinction is the display of arrays whose actual names are blended with internal names when calling NamedElement.getName().
• For method descriptions, representations of constructors and the type initializer, return the empty string.

Specified by:

getSourceCodeName in interface NamedElement

Returns:

The name of this type as represented in Java source code.

getPackageName

protected String getPackageName()

Returns the name of this type's package.

Returns:

The name of this type's package or null if this type is defined in the default package.

isConstantPool

public boolean isConstantPool()

Description copied from interface: TypeDescription

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.

Specified by:

isConstantPool in interface TypeDescription

Returns:

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

isPrimitiveWrapper

public boolean isPrimitiveWrapper()

Description copied from interface: TypeDescription

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

Specified by:

isPrimitiveWrapper in interface TypeDescription

Returns:

true if this type represents a wrapper type.

isAnnotationReturnType

public boolean isAnnotationReturnType()

Description copied from interface: TypeDescription

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

Specified by:

isAnnotationReturnType in interface TypeDescription

Returns:

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

isAnnotationValue

public boolean isAnnotationValue()

Description copied from interface: TypeDescription

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

Specified by:

isAnnotationValue in interface TypeDescription

Returns:

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

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object