org.jboss.jandex

Class TypeVariableReference

java.lang.Object

org.jboss.jandex.Type

org.jboss.jandex.TypeVariableReference

public final class TypeVariableReference
extends Type

Represents a reference to a type variable in the bound of a recursive type parameter. For example, if a class or method declares a type parameter T extends Comparable<T>, then the second occurence of T is represented as a type variable reference and not as a type variable, because it occurs in its own definition. A type variable which is fully defined before its occurence in a recursive type parameter is still represented as a type variable. For example, the recursive type parameter in the following class includes one type variable reference:

 abstract class Builder<T, THIS extends Builder<T, THIS>> {
     abstract T build();

     final THIS self() {
         return (THIS) this;
     }
 }
 

The identifier of the reference is THIS. The occurence of type variable T in the recursive type parameter is not represented as a reference, because it does not occur in its own definition. It is fully defined before.

The same holds for mutually recursive type parameters. If a type variable is fully defined before the type parameter in whose bound it occurs, it is represented as a type variable. It is represented as a type variable reference if it is defined after the type parameter in whose bound it occurs.

The type variable reference may be followed to obtain the original type variable.

Note that a type variable and a reference to that type variable may have different type annotations. Type annotations on the reference may be looked up from the reference, but when the reference is followed, the result is the original type variable with its own type annotations.

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.jandex.Type

Type.Kind

Field Summary

Fields inherited from class org.jboss.jandex.Type

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
static boolean	arrayEquals(org.jboss.jandex.Interned[] a, org.jboss.jandex.Interned[] b)
static int	arrayHashCode(org.jboss.jandex.Interned[] array)
TypeVariableReference	asTypeVariableReference() Casts this type to a TypeVariableReference and returns it if the kind is Type.Kind.TYPE_VARIABLE_REFERENCE.
boolean	equals(Object o) Compares this Type with another type.
TypeVariable	follow() Returns the type variable referred to by this reference.
int	hashCode() Computes a hash code representing this type.
String	identifier() Returns the identifier of this type variable reference as it appears in Java source code.
boolean	internEquals(Object o)
int	internHashCode()
Type.Kind	kind() Returns the kind of Type this is.
DotName	name() Returns the raw name of this type.

Methods inherited from class org.jboss.jandex.Type

annotation, annotations, annotationsWithRepeatable, asArrayType, asClassType, asParameterizedType, asPrimitiveType, asTypeVariable, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, createWithAnnotations, hasAnnotation, toString

Methods inherited from class java.lang.Object

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

Method Detail

name

public DotName name()

Description copied from class: Type

Returns the raw name of this type. Primitives and void are returned as the Java keyword (void, boolean, byte, short, int, long, float, double, char). Arrays are returned using the Java reflection array syntax (e.g. [[[Ljava.lang.String;) Classes are returned as a normal DotName.

Generic values are returned as the underlying raw value. For example, a wildcard such as ? extends Number has a raw type of Number.

Overrides:

name in class Type

Returns:

the name of this type

identifier

public String identifier()

Returns the identifier of this type variable reference as it appears in Java source code.

For example, the following class has a recursive type parameter E with one reference:

 abstract class MyEnum<E extends MyEnum<E>> {
 }
 

The identifier of the reference is E.

Returns:

the identifier of this type variable reference

follow

public TypeVariable follow()

Returns the type variable referred to by this reference.

kind

public Type.Kind kind()

Description copied from class: Type

Returns the kind of Type this is.

Specified by:

kind in class Type

Returns:

the kind

asTypeVariableReference

public TypeVariableReference asTypeVariableReference()

Description copied from class: Type

Casts this type to a TypeVariableReference and returns it if the kind is Type.Kind.TYPE_VARIABLE_REFERENCE. Throws an exception otherwise.

Overrides:

asTypeVariableReference in class Type

Returns:

a TypeVariableReference

equals

public boolean equals(Object o)

Description copied from class: Type

Compares this Type with another type. A type is equal to another type if it is of the same kind, and all of their fields are equal. This includes annotations, which must be equal as well.

Overrides:

equals in class Type

Parameters:

o - the type to compare to

Returns:

true if equal

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: Type

Computes a hash code representing this type.

Overrides:

hashCode in class Type

Returns:

the hash code

internEquals

public boolean internEquals(Object o)

Overrides:

internEquals in class Type

internHashCode

public int internHashCode()

Overrides:

internHashCode in class Type

arrayEquals

public static boolean arrayEquals(org.jboss.jandex.Interned[] a,
                                  org.jboss.jandex.Interned[] b)

arrayHashCode

public static int arrayHashCode(org.jboss.jandex.Interned[] array)