Type (Jandex: Core 3.0.1 API)

java.lang.Object
- org.jboss.jandex.Type

Direct Known Subclasses:

ArrayType, ClassType, ParameterizedType, PrimitiveType, TypeVariable, TypeVariableReference, UnresolvedTypeVariable, VoidType, WildcardType
```
public abstract class Type
extends Object
```
Represents a Java type usage that is specified on methods, fields, classes, annotations, or other types. A type can be any class based type (interface, class, annotation), any primitive, any array, any generic type declaration, or void.
A type usage may have annotations associated with its declaration. A type is equal to another type if, and only if, it represents the same exact definition including the annotations specific to its usage.
To reduce memory overhead, type instances are often shared between their enclosing classes.

Author:

Jason T. Greene

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Type.Kind
Represents a "kind" of Type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Type.Kind` Represents a "kind" of Type.

Field Summary

Fields
Modifier and Type Field and Description

static Type[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static Type[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`AnnotationInstance`	`annotation(DotName name)` Returns the annotation instance with given name declared on this type usage.
`List<AnnotationInstance>`	`annotations()` Returns the annotation instances declared on this type usage.
`List<AnnotationInstance>`	`annotationsWithRepeatable(DotName name, IndexView index)` Returns the annotation instances with given name declared on this type usage.
`static boolean`	`arrayEquals(org.jboss.jandex.Interned[] a, org.jboss.jandex.Interned[] b)`
`static int`	`arrayHashCode(org.jboss.jandex.Interned[] array)`
`ArrayType`	`asArrayType()` Casts this type to an `ArrayType` and returns it if the kind is `Type.Kind.ARRAY`.
`ClassType`	`asClassType()` Casts this type to a `ClassType` and returns it if the kind is `Type.Kind.CLASS`.
`ParameterizedType`	`asParameterizedType()` Casts this type to a `ParameterizedType` and returns it if the kind is `Type.Kind.PARAMETERIZED_TYPE`.
`PrimitiveType`	`asPrimitiveType()` Casts this type to a `PrimitiveType` and returns it if the kind is `Type.Kind.PRIMITIVE`.
`TypeVariable`	`asTypeVariable()` Casts this type to a `TypeVariable` and returns it if the kind is `Type.Kind.TYPE_VARIABLE`.
`TypeVariableReference`	`asTypeVariableReference()` Casts this type to a `TypeVariableReference` and returns it if the kind is `Type.Kind.TYPE_VARIABLE_REFERENCE`.
`UnresolvedTypeVariable`	`asUnresolvedTypeVariable()` Casts this type to an `UnresolvedTypeVariable` and returns it if the kind is `Type.Kind.UNRESOLVED_TYPE_VARIABLE`.
`VoidType`	`asVoidType()` Casts this type to a `VoidType` and returns it if the kind is `Type.Kind.VOID`.
`WildcardType`	`asWildcardType()` Casts this type to a `WildcardType` and returns it if the kind is `Type.Kind.WILDCARD_TYPE`.
`static Type`	`create(DotName name, Type.Kind kind)` Creates a type instance of the specified kind.
`static Type`	`createWithAnnotations(DotName name, Type.Kind kind, AnnotationInstance[] annotations)` Creates an instance of specified type with given type `annotations`.
`boolean`	`equals(Object o)` Compares this `Type` with another type.
`boolean`	`hasAnnotation(DotName name)` Returns whether an annotation instance with given name is declared on this type usage.
`int`	`hashCode()` Computes a hash code representing this type.
`boolean`	`internEquals(Object o)`
`int`	`internHashCode()`
`abstract Type.Kind`	`kind()` Returns the kind of Type this is.
`DotName`	`name()` Returns the raw name of this type.
`String`	`toString()` Returns a string representation for this type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final Type[] EMPTY_ARRAY
```
- Method Detail
  - create
```
public static Type create(DotName name,
                          Type.Kind kind)
```
    Creates a type instance of the specified kind. If kind is CLASS, the name is used as is. If kind is ARRAY, the name must be in the Java reflection format (Java descriptor format changing / to ., e.g. [[[[Ljava.lang.String;" or [[[I). If kind is PRIMITIVE, the name must be in the Java reflection format (which is equal to the Java keyword denoting the primitive type, e.g. int). If kind is VOID, the name is ignored. All other kinds cause an exception.
    
    Parameters:
    
    name - the name of type to use or parse
    
    kind - the kind of type to create
    
    Returns:
    
    the type
    
    Throws:
    
    IllegalArgumentException - if the kind is no supported
  - createWithAnnotations
```
public static Type createWithAnnotations(DotName name,
                                         Type.Kind kind,
                                         AnnotationInstance[] annotations)
```
    Creates an instance of specified type with given type annotations. To create the type instance, this method delegates to create(DotName, Kind).
    
    Parameters:
    
    name - the name of type to use or parse
    
    kind - the kind of type to create
    
    annotations - the type annotations that should be present on the type instance
    
    Returns:
    
    the annotated type
    
    Throws:
    
    IllegalArgumentException - if the kind is no supported
  - name
```
public DotName name()
```
    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.
    
    Returns:
    
    the name of this type
  - kind
```
public abstract Type.Kind kind()
```
    Returns the kind of Type this is.
    
    Returns:
    
    the kind
  - asClassType
```
public ClassType asClassType()
```
    Casts this type to a ClassType and returns it if the kind is Type.Kind.CLASS. Throws an exception otherwise.
    
    Returns:
    
    a ClassType
    
    Throws:
    
    IllegalArgumentException - if not a class
    
    Since:
    
    2.0
  - asParameterizedType
```
public ParameterizedType asParameterizedType()
```
    Casts this type to a ParameterizedType and returns it if the kind is Type.Kind.PARAMETERIZED_TYPE. Throws an exception otherwise.
    
    Returns:
    
    a ParameterizedType
    
    Throws:
    
    IllegalArgumentException - if not a parameterized type
    
    Since:
    
    2.0
  - asTypeVariable
```
public TypeVariable asTypeVariable()
```
    Casts this type to a TypeVariable and returns it if the kind is Type.Kind.TYPE_VARIABLE. Throws an exception otherwise.
    
    Returns:
    
    a TypeVariable
    
    Throws:
    
    IllegalArgumentException - if not a type variable
    
    Since:
    
    2.0
  - asTypeVariableReference
```
public TypeVariableReference asTypeVariableReference()
```
    Casts this type to a TypeVariableReference and returns it if the kind is Type.Kind.TYPE_VARIABLE_REFERENCE. Throws an exception otherwise.
    
    Returns:
    
    a TypeVariableReference
    
    Throws:
    
    IllegalArgumentException - if not a type variable
    
    Since:
    
    2.0
  - asArrayType
```
public ArrayType asArrayType()
```
    Casts this type to an ArrayType and returns it if the kind is Type.Kind.ARRAY. Throws an exception otherwise.
    
    Returns:
    
    an ArrayType
    
    Throws:
    
    IllegalArgumentException - if not an array type
    
    Since:
    
    2.0
  - asWildcardType
```
public WildcardType asWildcardType()
```
    Casts this type to a WildcardType and returns it if the kind is Type.Kind.WILDCARD_TYPE. Throws an exception otherwise.
    
    Returns:
    
    a WildcardType
    
    Throws:
    
    IllegalArgumentException - if not a wildcard type
    
    Since:
    
    2.0
  - asUnresolvedTypeVariable
```
public UnresolvedTypeVariable asUnresolvedTypeVariable()
```
    Casts this type to an UnresolvedTypeVariable and returns it if the kind is Type.Kind.UNRESOLVED_TYPE_VARIABLE. Throws an exception otherwise.
    
    Returns:
    
    an UnresolvedTypeVariable
    
    Throws:
    
    IllegalArgumentException - if not an unresolved type
    
    Since:
    
    2.0
  - asPrimitiveType
```
public PrimitiveType asPrimitiveType()
```
    Casts this type to a PrimitiveType and returns it if the kind is Type.Kind.PRIMITIVE. Throws an exception otherwise.
    
    Returns:
    
    a PrimitiveType
    
    Throws:
    
    IllegalArgumentException - if not a primitive type
    
    Since:
    
    2.0
  - asVoidType
```
public VoidType asVoidType()
```
    Casts this type to a VoidType and returns it if the kind is Type.Kind.VOID. Throws an exception otherwise.
    
    Returns:
    
    a VoidType
    
    Throws:
    
    IllegalArgumentException - if not a void type
    
    Since:
    
    2.0
  - hasAnnotation
```
public final boolean hasAnnotation(DotName name)
```
    Returns whether an annotation instance with given name is declared on this type usage.
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    true if the annotation is present, false otherwise
    
    See Also:
    
    annotation(DotName)
  - annotation
```
public final AnnotationInstance annotation(DotName name)
```
    Returns the annotation instance with given name declared on this type usage.
    To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    the annotation instance, or null if not found
  - annotationsWithRepeatable
```
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name,
                                                                IndexView index)
```
    Returns the annotation instances with given name declared on this type usage.
    If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.
    To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.
    
    Parameters:
    
    name - name of the annotation type, must not be null
    
    index - index used to obtain the annotation type, must not be null
    
    Returns:
    
    immutable list of annotation instances, never null
    
    Throws:
    
    IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
    
    Since:
    
    3.0
    
    See Also:
    
    annotations()
  - annotations
```
public List<AnnotationInstance> annotations()
```
    Returns the annotation instances declared on this type usage.
    To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.
    
    Returns:
    
    immutable list of annotation instances, never null
    
    Since:
    
    2.0
  - toString
```
public String toString()
```
    Returns a string representation for this type. It is similar, yet not identical to a Java source code representation.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation.
  - equals
```
public boolean equals(Object o)
```
    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 Object
    
    Parameters:
    
    o - the type to compare to
    
    Returns:
    
    true if equal
    
    See Also:
    
    Object.equals(Object)
  - hashCode
```
public int hashCode()
```
    Computes a hash code representing this type.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code
  - internEquals
```
public boolean internEquals(Object o)
```
  - internHashCode
```
public int internHashCode()
```
  - 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)
```

Class Type

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Method Detail

create

createWithAnnotations

name

kind

asClassType

asParameterizedType

asTypeVariable

asTypeVariableReference

asArrayType

asWildcardType

asUnresolvedTypeVariable

asPrimitiveType

asVoidType

hasAnnotation

annotation

annotationsWithRepeatable

annotations

toString

equals

hashCode

internEquals

internHashCode

arrayEquals

arrayHashCode