Class ClassType

java.lang.Object

org.jboss.jandex.Type

org.jboss.jandex.ClassType

All Implemented Interfaces:

Descriptor

public final class ClassType
extends Type

Represents a class type. Class types also include erasures of parameterized types.

Note that an inner class type enclosed in a parameterized type or in a type annotated with a type annotation is represented as ParameterizedType, where the enclosing type is represented as the parameterized type's owner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClassType.Builder	Convenient builder for ClassType.

Nested classes/interfaces inherited from class Type

Type.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final ClassType	BOOLEAN_CLASS
static final ClassType	BYTE_CLASS
static final ClassType	CHARACTER_CLASS
static final ClassType	CLASS_TYPE
static final ClassType	DOUBLE_CLASS
static final ClassType	FLOAT_CLASS
static final ClassType	INTEGER_CLASS
static final ClassType	LONG_CLASS
static final ClassType	OBJECT_TYPE
static final ClassType	SHORT_CLASS
static final ClassType	STRING_TYPE
static final ClassType	VOID_CLASS

Fields inherited from class Type

EMPTY_ARRAY

Fields inherited from interface Descriptor

NO_SUBSTITUTION

Constructor Summary

Constructors

Constructor	Description
ClassType(DotName name)
ClassType(DotName name, AnnotationInstance[] annotations)

Method Summary

Modifier and Type	Method	Description
ClassType	asClassType()	Casts this type to a ClassType and returns it if the kind is Type.Kind.CLASS.
static ClassType.Builder	builder(Class<?> clazz)	Create a builder of a class type for the given class.
static ClassType.Builder	builder(DotName name)	Create a builder of a class type with the given name.
(package private) Type	copyType(AnnotationInstance[] newAnnotations)
static ClassType	create(Class<?> clazz)	Create an instance of a class type for given clazz.
static ClassType	create(String name)	Create an instance of a class type with given name.
static ClassType	create(DotName name)	Create an instance of a class type with given name.
Type.Kind	kind()	Returns the kind of Type this is.
(package private) ParameterizedType	toParameterizedType()

Methods inherited from class Type

addAnnotation, annotation, annotationArray, annotations, annotationsWithRepeatable, appendAnnotations, asArrayType, asParameterizedType, asPrimitiveType, asTypeVariable, asTypeVariableReference, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, createWithAnnotations, descriptor, equals, hasAnnotation, hashCode, internEquals, internHashCode, name, parse, toString, toString, withoutAnnotations

Methods inherited from class Object

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

Methods inherited from interface Descriptor

descriptor

Field Details

OBJECT_TYPE

public static final ClassType OBJECT_TYPE

STRING_TYPE

public static final ClassType STRING_TYPE

CLASS_TYPE

public static final ClassType CLASS_TYPE

BYTE_CLASS

public static final ClassType BYTE_CLASS

CHARACTER_CLASS

public static final ClassType CHARACTER_CLASS

DOUBLE_CLASS

public static final ClassType DOUBLE_CLASS

FLOAT_CLASS

public static final ClassType FLOAT_CLASS

INTEGER_CLASS

public static final ClassType INTEGER_CLASS

LONG_CLASS

public static final ClassType LONG_CLASS

SHORT_CLASS

public static final ClassType SHORT_CLASS

BOOLEAN_CLASS

public static final ClassType BOOLEAN_CLASS

VOID_CLASS

public static final ClassType VOID_CLASS

Constructor Details

ClassType

ClassType(DotName name)

ClassType

ClassType(DotName name,
 AnnotationInstance[] annotations)

Method Details

create

public static ClassType create(DotName name)

Create an instance of a class type with given name.

Note that an inner class type enclosed in a parameterized type or in a type annotated with a type annotation is represented as ParameterizedType, where the enclosing type is represented as the parameterized type's owner.

Parameters:

name - the binary name of this class type

Returns:

the class type

Since:

3.0.4

create

public static ClassType create(String name)

Create an instance of a class type with given name.

Note that an inner class type enclosed in a parameterized type or in a type annotated with a type annotation is represented as ParameterizedType, where the enclosing type is represented as the parameterized type's owner.

Parameters:

name - the binary name of this class type

Returns:

the class type

Since:

3.1.0

create

public static ClassType create(Class<?> clazz)

Create an instance of a class type for given clazz.

Note that an inner class type enclosed in a parameterized type or in a type annotated with a type annotation is represented as ParameterizedType, where the enclosing type is represented as the parameterized type's owner.

Parameters:

clazz - the class

Returns:

the class type

Since:

3.1.0

builder

public static ClassType.Builder builder(DotName name)

Create a builder of a class type with the given name.

Parameters:

name - binary name of the class

Returns:

the builder

Since:

3.1.0

builder

public static ClassType.Builder builder(Class<?> clazz)

Create a builder of a class type for the given class.

Parameters:

clazz - the class

Returns:

the builder

Since:

3.1.0

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

asClassType

public ClassType asClassType()

Description copied from class: Type

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

Overrides:

asClassType in class Type

Returns:

a ClassType

copyType

Type copyType(AnnotationInstance[] newAnnotations)

Specified by:

copyType in class Type

toParameterizedType

ParameterizedType toParameterizedType()