Package 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.

Since:

2.0

Nested Class Summary

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

Type.Kind

Field Summary

Fields

Modifier and Type	Field	Description
private Type	component
private int	dimensions
private int	hash

Fields inherited from class org.jboss.jandex.Type

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ArrayType(Type component, int dimensions)
ArrayType(Type component, int dimensions, AnnotationInstance[] annotations)

Method Summary

Modifier and Type	Method	Description
private void	appendArraySyntax(java.lang.StringBuilder builder)
private void	appendRootComponent(java.lang.StringBuilder builder)
ArrayType	asArrayType()	Casts this type to an ArrayType and returns it if the kind is Type.Kind.ARRAY Throws an exception otherwise.
Type	component()	Returns the component type of the array.
(package private) Type	copyType(AnnotationInstance[] newAnnotations)
(package private) Type	copyType(Type component, int dimensions)
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(java.lang.Object o)	Compares this Type with another type, and returns true if they are equivalent.
int	hashCode()	Computes a hash code representing this type.
Type.Kind	kind()	Returns the kind of Type this is.
DotName	name()	Returns the raw name of this type.
java.lang.String	toString()	Returns a string representation for this type.

Methods inherited from class org.jboss.jandex.Type

addAnnotation, annotation, annotationArray, annotations, appendAnnotations, asClassType, asParameterizedType, asPrimitiveType, asTypeVariable, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, hasAnnotation, toString

Methods inherited from class java.lang.Object

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

Field Detail

component

private final Type component

dimensions

private final int dimensions

hash

private int hash

Constructor Detail

ArrayType

ArrayType(Type component,
          int dimensions)

ArrayType

ArrayType(Type component,
          int dimensions,
          AnnotationInstance[] annotations)

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. As an example, String[] has a component type of String

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 reserved word (void, boolean, byte, short, char, int, long, float, double). 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

toString

public java.lang.String toString()

Description copied from class: Type

Returns a string representation for this type. It is similar, yet not equivalent to a Java source code representation.

Overrides:

toString in class Type

Returns:

the string representation.

appendRootComponent

private void appendRootComponent(java.lang.StringBuilder builder)

appendArraySyntax

private void appendArraySyntax(java.lang.StringBuilder builder)

dimensions

public int dimensions()

The number of dimensions this array type has. For example, String[][], would return a value of 2.

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:

a ClassType

equals

public boolean equals(java.lang.Object o)

Description copied from class: Type

Compares this Type with another type, and returns true if they are equivalent. A type is equivalent to another type if it is the same kind, and all of its 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

copyType

Type copyType(AnnotationInstance[] newAnnotations)

Specified by:

copyType in class Type

copyType

Type copyType(Type component,
              int dimensions)