org.jboss.jandex

Class ArrayType

java.lang.Object

org.jboss.jandex.Type

org.jboss.jandex.ArrayType

public final class ArrayType
extends Type

Represents a Java array type declaration.

Author:

Jason T. Greene

Since:

2.0

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)
ArrayType	asArrayType() Casts this type to an ArrayType and returns it if the kind is Type.Kind.ARRAY.
Type	component() Returns the component type of the array.
static ArrayType	create(Type component, int dimensions) Create a new mock array type instance with the specified component and dimensions.
int	dimensions() The number of dimensions this array type has.
boolean	equals(Object o) Compares this Type with another type.
int	hashCode() Computes a hash code representing this type.
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, asClassType, asParameterizedType, asPrimitiveType, asTypeVariable, asTypeVariableReference, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, createWithAnnotations, hasAnnotation, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ArrayType create(Type component,
                               int dimensions)

Create a new mock array type instance with the specified component and dimensions.

Parameters:

component - the array component

dimensions - the number of dimensions of this array

Returns:

the new mock array type instance

Since:

2.1

component

public Type component()

Returns the component type of the array. For example, String[] has a component type of String.

It is possible for an ArrayType to have another ArrayType as its component type. This happens when an array has some of its dimensions annotated (e.g. String[] @Ann []). In such case, having multiple nested ArrayTypes is necessary to faithfully represent the annotations.

Returns:

the component type

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

dimensions

public int dimensions()

The number of dimensions this array type has. For example, this method would return 2 for an array type of String[][].

Note that an ArrayType may have another ArrayType as its component type (see component()). For example, String[] @Ann [] is an array type with 1 dimension and a component type of another array type, also with 1 dimension.

Returns:

the number of dimensions of this array type

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

asArrayType

public ArrayType asArrayType()

Description copied from class: Type

Casts this type to an ArrayType and returns it if the kind is Type.Kind.ARRAY. Throws an exception otherwise.

Overrides:

asArrayType in class Type

Returns:

an ArrayType

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)