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
- Author:
- Jason T. Greene
-
-
Field Summary
-
Fields inherited from class org.jboss.jandex.Type
EMPTY_ARRAY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ArrayType
asArrayType()
Casts this type to anArrayType
and returns it if the kind isType.Kind.ARRAY
Throws an exception otherwise.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, 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.String
toString()
Returns a string representation for this type.-
Methods inherited from class org.jboss.jandex.Type
annotation, annotations, asClassType, asParameterizedType, asPrimitiveType, asTypeVariable, asUnresolvedTypeVariable, asVoidType, asWildcardType, create, hasAnnotation
-
-
-
-
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 componentdimensions
- 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 ofString
- 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 normalDotName
.Generic values are returned as the underlying raw value. For example, a wildcard such as
? extends Number
, has a raw type ofNumber
-
toString
public 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.
-
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
-
asArrayType
public ArrayType asArrayType()
Description copied from class:Type
Casts this type to anArrayType
and returns it if the kind isType.Kind.ARRAY
Throws an exception otherwise.- Overrides:
asArrayType
in classType
- Returns:
- a
ClassType
-
equals
public boolean equals(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 classType
- Parameters:
o
- the type to compare to- Returns:
- true if equal
- See Also:
Object.equals(Object)
-
-