A type is used in a program source code, but does not have to be declared anywhere.

For example, the int type exists even if it is not declared in any Java source file, while the java.lang.String type is declared by the class of the same name. Array types, such as int[] or String[][], are not declared anywhere either, but their element types may be. A generic class, such as java.util.List, declares a raw type of the same name, but it does not declare the parameterized types, such as List<String>. Parameterized types are created by applying type arguments to generic classes. For example, the List<String> type is created by applying String to List<T>.

Types occur on many places. A field has a type, a method has a return type, a method parameter has a type, even the extends clause in a class declaration contains a type. Occurences of types may be annotated.

Types are:

the void pseudo-type
a primitive type, such as int
a class type, such as String
an array type, such as int[] or String[][]
a parameterized type, such as List<String>
a type variable, such as T when used in a class that declares a type parameter T
a wildcard type, such as the type argument in List<? extends Number>

Class types and parameterized types allow obtaining their class declarations.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Type.Kind

Method Summary

Modifier and Type	Method and Description
public default ArrayType	Returns: this array type, never `null` asArray() Returns this type as an array type.
public default ClassType	Returns: this class type, never `null` asClass() Returns this type as a class type.
public default DeclarationInfo	asDeclaration() Implements jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration. Returns this annotation target as a declaration.
public default ParameterizedType	Returns: this parameterized type, never `null` asParameterizedType() Returns this type as a parameterized type.
public default PrimitiveType	Returns: this primitive type, never `null` asPrimitive() Returns this type as a primitive type.
public default Type	asType() Implements jakarta.enterprise.lang.model.AnnotationTarget.asType. Returns this annotation target as a type.
public default TypeVariable	Returns: this type variable, never `null` asTypeVariable() Returns this type as a type variable.
public default VoidType	Returns: this void type, never `null` asVoid() Returns this type as the void pseudo-type.
public default WildcardType	Returns: this wildcard type, never `null` asWildcardType() Returns this type as a wildcard type.
public default boolean	Returns: `true` if this is an array type, `false` otherwise isArray() Returns whether this type is an array type.
public default boolean	Returns: `true` if this is a class type, `false` otherwise isClass() Returns whether this type is a class type.
public default boolean	isDeclaration() Implements jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration. Returns whether this annotation target is a declaration.
public default boolean	Returns: `true` if this is a parameterized type, `false` otherwise isParameterizedType() Returns whether this type is a parameterized type.
public default boolean	Returns: `true` if this is a primitive type, `false` otherwise isPrimitive() Returns whether this type is a primitive type.
public default boolean	isType() Implements jakarta.enterprise.lang.model.AnnotationTarget.isType. Returns whether this annotation target is a type.
public default boolean	Returns: `true` if this is a primitive type, `false` otherwise isTypeVariable() Returns whether this type is a type variable.
public default boolean	Returns: `true` if this is void, `false` otherwise isVoid() Returns whether this type is the void pseudo-type.
public default boolean	Returns: `true` if this is a wildcard type, `false` otherwise isWildcardType() Returns whether this type is a wildcard type.
public Type.Kind	Returns: the kind of this type kind() Returns the kind of this type.

Inherited from jakarta.enterprise.lang.model.AnnotationTarget:: annotation annotations annotations hasAnnotation hasAnnotation repeatableAnnotation

Method Detail

asArray back to summary

asArray	back to summary
public default ArrayType asArray() Returns this type as an array type. Returns:ArrayType this array type, never `null` Exceptions IllegalStateException: if `isArray()` returns `false`

public default ArrayType asArray()

Returns this type as an array type.

Returns:ArrayType

this array type, never null

Exceptions

IllegalStateException:: if isArray() returns false

asClass back to summary

asClass	back to summary
public default ClassType asClass() Returns this type as a class type. Returns:ClassType this class type, never `null` Exceptions IllegalStateException: if `isClass()` returns `false`

public default ClassType asClass()

Returns this type as a class type.

Returns:ClassType

this class type, never null

Exceptions

IllegalStateException:: if isClass() returns false

asDeclaration back to summary

asDeclaration	back to summary
public default DeclarationInfo asDeclaration() Implements jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration. Doc from jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration. Returns this annotation target as a declaration. Returns:DeclarationInfo this declaration, never `null` Annotations @Override

public default DeclarationInfo asDeclaration()

Implements jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration.

Returns this annotation target as a declaration.

Returns:DeclarationInfo

this declaration, never null

Annotations

@Override

asParameterizedType back to summary

asParameterizedType	back to summary
public default ParameterizedType asParameterizedType() Returns this type as a parameterized type. Returns:ParameterizedType this parameterized type, never `null` Exceptions IllegalStateException: if `isParameterizedType()` returns `false`

public default ParameterizedType asParameterizedType()

Returns this type as a parameterized type.

Returns:ParameterizedType

this parameterized type, never null

Exceptions

IllegalStateException:: if isParameterizedType() returns false

asPrimitive back to summary

asPrimitive	back to summary
public default PrimitiveType asPrimitive() Returns this type as a primitive type. Returns:PrimitiveType this primitive type, never `null` Exceptions IllegalStateException: if `isPrimitive()` returns `false`

public default PrimitiveType asPrimitive()

Returns this type as a primitive type.

Returns:PrimitiveType

this primitive type, never null

Exceptions

IllegalStateException:: if isPrimitive() returns false

asType back to summary

asType	back to summary
public default Type asType() Implements jakarta.enterprise.lang.model.AnnotationTarget.asType. Doc from jakarta.enterprise.lang.model.AnnotationTarget.asType. Returns this annotation target as a type. Returns:Type this type, never `null` Annotations @Override

public default Type asType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.asType.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.asType.

Returns this annotation target as a type.

Returns:Type

this type, never null

Annotations

@Override

asTypeVariable back to summary

asTypeVariable	back to summary
public default TypeVariable asTypeVariable() Returns this type as a type variable. Type variables are also used to represent type parameters in declarations of parameterized types. Returns:TypeVariable this type variable, never `null` Exceptions IllegalStateException: if `isTypeVariable()` returns `false`

public default TypeVariable asTypeVariable()

Returns this type as a type variable. Type variables are also used to represent type parameters in declarations of parameterized types.

Returns:TypeVariable

this type variable, never null

Exceptions

IllegalStateException:: if isTypeVariable() returns false

asVoid back to summary

asVoid	back to summary
public default VoidType asVoid() Returns this type as the void pseudo-type. Returns:VoidType this void type, never `null` Exceptions IllegalStateException: if `isVoid()` returns `false`

public default VoidType asVoid()

Returns this type as the void pseudo-type.

Returns:VoidType

this void type, never null

Exceptions

IllegalStateException:: if isVoid() returns false

asWildcardType back to summary

asWildcardType	back to summary
public default WildcardType asWildcardType() Returns this type as a wildcard type. Returns:WildcardType this wildcard type, never `null` Exceptions IllegalStateException: if `isWildcardType()` returns `false`

public default WildcardType asWildcardType()

Returns this type as a wildcard type.

Returns:WildcardType

this wildcard type, never null

Exceptions

IllegalStateException:: if isWildcardType() returns false

isArray back to summary

isArray	back to summary
public default boolean isArray() Returns whether this type is an array type. Returns:boolean `true` if this is an array type, `false` otherwise

public default boolean isArray()

Returns whether this type is an array type.

Returns:boolean: true if this is an array type, false otherwise

isClass back to summary

isClass	back to summary
public default boolean isClass() Returns whether this type is a class type. Returns:boolean `true` if this is a class type, `false` otherwise

public default boolean isClass()

Returns whether this type is a class type.

Returns:boolean: true if this is a class type, false otherwise

isDeclaration back to summary

isDeclaration	back to summary
public default boolean isDeclaration() Implements jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration. Doc from jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration. Returns whether this annotation target is a declaration. Returns:boolean `true` if this is a declaration, `false` otherwise Annotations @Override

public default boolean isDeclaration()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration.

Returns whether this annotation target is a declaration.

Returns:boolean

true if this is a declaration, false otherwise

Annotations

@Override

isParameterizedType back to summary

isParameterizedType	back to summary
public default boolean isParameterizedType() Returns whether this type is a parameterized type. Returns:boolean `true` if this is a parameterized type, `false` otherwise

public default boolean isParameterizedType()

Returns whether this type is a parameterized type.

Returns:boolean: true if this is a parameterized type, false otherwise

isPrimitive back to summary

isPrimitive	back to summary
public default boolean isPrimitive() Returns whether this type is a primitive type. Returns:boolean `true` if this is a primitive type, `false` otherwise

public default boolean isPrimitive()

Returns whether this type is a primitive type.

Returns:boolean: true if this is a primitive type, false otherwise

isType back to summary

isType	back to summary
public default boolean isType() Implements jakarta.enterprise.lang.model.AnnotationTarget.isType. Doc from jakarta.enterprise.lang.model.AnnotationTarget.isType. Returns whether this annotation target is a type. Returns:boolean `true` if this is a type, `false` otherwise Annotations @Override

public default boolean isType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isType.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.isType.

Returns whether this annotation target is a type.

Returns:boolean

true if this is a type, false otherwise

Annotations

@Override

isTypeVariable back to summary

isTypeVariable	back to summary
public default boolean isTypeVariable() Returns whether this type is a type variable. Type variables are also used to represent type parameters in declarations of parameterized types. Returns:boolean `true` if this is a primitive type, `false` otherwise

public default boolean isTypeVariable()

Returns whether this type is a type variable. Type variables are also used to represent type parameters in declarations of parameterized types.

Returns:boolean: true if this is a primitive type, false otherwise

isVoid back to summary

isVoid	back to summary
public default boolean isVoid() Returns whether this type is the void pseudo-type. Returns:boolean `true` if this is void, `false` otherwise

public default boolean isVoid()

Returns whether this type is the void pseudo-type.

Returns:boolean: true if this is void, false otherwise

isWildcardType back to summary

isWildcardType	back to summary
public default boolean isWildcardType() Returns whether this type is a wildcard type. Returns:boolean `true` if this is a wildcard type, `false` otherwise

public default boolean isWildcardType()

Returns whether this type is a wildcard type.

Returns:boolean: true if this is a wildcard type, false otherwise

kind	back to summary
public Type.Kind kind() Returns the kind of this type. Returns:Type.Kind the kind of this type

kind

back to summary

public Type.Kind kind()

Returns the kind of this type.

Returns:Type.Kind: the kind of this type

jakarta.enterprise.lang.model.types back to summary

public final Enum Type.Kind

Class Inheritance

extends Enum<Type.Kind>

java.lang.Object
java.lang.Enum
jakarta.enterprise.lang.model.types.Type.Kind

Field Summary

Modifier and Type	Field and Description
public static final Type.Kind	ARRAY E.g. when method returns `int[]` or `String[][]`.
public static final Type.Kind	CLASS E.g. when method returns `String`.
public static final Type.Kind	PARAMETERIZED_TYPE E.g. when method returns `List<String>`.
public static final Type.Kind	PRIMITIVE E.g. when method returns `int`.
public static final Type.Kind	TYPE_VARIABLE E.g. when method returns `T` and `T` is a type parameter of the declaring class.
public static final Type.Kind	VOID E.g. when method returns `void`.
public static final Type.Kind	WILDCARD_TYPE E.g. when method returns `List<?`

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static Type.Kind	valueOf(String name)
public static Type.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ARRAY	back to summary
public static final Type.Kind ARRAY E.g. when method returns `int[]` or `String[][]`.

CLASS	back to summary
public static final Type.Kind CLASS E.g. when method returns `String`.

PARAMETERIZED_TYPE	back to summary
public static final Type.Kind PARAMETERIZED_TYPE E.g. when method returns `List<String>`.

PRIMITIVE	back to summary
public static final Type.Kind PRIMITIVE E.g. when method returns `int`.

TYPE_VARIABLE	back to summary
public static final Type.Kind TYPE_VARIABLE E.g. when method returns `T` and `T` is a type parameter of the declaring class.

VOID	back to summary
public static final Type.Kind VOID E.g. when method returns `void`.

WILDCARD_TYPE	back to summary
public static final Type.Kind WILDCARD_TYPE E.g. when method returns `List<? extends Number>`. The kind of such type is `PARAMETERIZED_TYPE`, but the first (and only) type argument is a `WILDCARD_TYPE`.

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static Type.Kind valueOf(String name)

values	back to summary
public static Type.Kind[] values()

public Interface Type

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Type.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail