Package org.jboss.jandex

Class PrimitiveType

java.lang.Object

org.jboss.jandex.Type

org.jboss.jandex.PrimitiveType

All Implemented Interfaces:

Descriptor

public final class PrimitiveType
extends Type

Represents a primitive Java type. While a set of constants is provided for easy of use, instance equality should not be used to compare to them. Instead equals(Object) should be used.

A primitive is considered equal to another primitive if it specifies the same primitive enumeration value, and contains an equal set of annotation instances.

Author:

Jason T. Greene

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrimitiveType.Primitive	Specifies the underlying Java primitive type for a PrimitiveType

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

Type.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final PrimitiveType	BOOLEAN
static final PrimitiveType	BYTE
static final PrimitiveType	CHAR
static final PrimitiveType	DOUBLE
static final PrimitiveType	FLOAT
static final PrimitiveType	INT
static final PrimitiveType	LONG
static final PrimitiveType	SHORT

Fields inherited from class org.jboss.jandex.Type

EMPTY_ARRAY

Fields inherited from interface org.jboss.jandex.Descriptor

NO_SUBSTITUTION

Method Summary

Modifier and Type	Method	Description
PrimitiveType	asPrimitiveType()	Casts this type to a PrimitiveType and returns it if the kind is Type.Kind.PRIMITIVE.
boolean	equals(Object o)	Compares this Type with another type.
int	hashCode()	Computes a hash code representing this type.
Type.Kind	kind()	Returns the kind of Type this is.
PrimitiveType.Primitive	primitive()	The type of primitive this primitive type represents

Methods inherited from class org.jboss.jandex.Type

annotation, annotations, annotationsWithRepeatable, asArrayType, asClassType, asParameterizedType, asTypeVariable, asTypeVariableReference, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, createWithAnnotations, descriptor, hasAnnotation, name, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.jandex.Descriptor

descriptor

Field Details

BYTE

public static final PrimitiveType BYTE

CHAR

public static final PrimitiveType CHAR

DOUBLE

public static final PrimitiveType DOUBLE

FLOAT

public static final PrimitiveType FLOAT

INT

public static final PrimitiveType INT

LONG

public static final PrimitiveType LONG

SHORT

public static final PrimitiveType SHORT

BOOLEAN

public static final PrimitiveType BOOLEAN

Method Details

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

primitive

public PrimitiveType.Primitive primitive()

The type of primitive this primitive type represents

Returns:

the primitive

asPrimitiveType

public PrimitiveType asPrimitiveType()

Description copied from class: Type

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

Overrides:

asPrimitiveType in class Type

Returns:

a PrimitiveType

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