Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv abstract static class	Type.Builder< self type THIS extends Type.Builder<THIS>> Base class for type builders.
public static enum	Type.Kind Represents a "kind" of Type.

Field Summary

Modifier and Type	Field and Description
private final AnnotationInstance[]	annotations
private static final AnnotationInstance[]	EMPTY_ANNOTATIONS
public static final Type[]	EMPTY_ARRAY
private final DotName	name

Constructor Summary

Access	Constructor and Description
pack-priv	Type(DotName name, AnnotationInstance[] annotations)

Method Summary

Modifier and Type	Method and Description
pack-priv Type	addAnnotation(AnnotationInstance annotation)
public final AnnotationInstance	Returns: the annotation instance, or `null` if not found annotation(DotName name of the annotation type to look for, must not be `null` name) Returns the annotation instance with given name declared on this type usage.
pack-priv AnnotationInstance[]	annotationArray()
public List<AnnotationInstance>	Returns: immutable list of annotation instances, never `null` annotations() Returns the annotation instances declared on this type usage.
public final List<AnnotationInstance>	Returns: immutable list of annotation instances, never `null` annotationsWithRepeatable(DotName name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances with given name declared on this type usage.
pack-priv void	appendAnnotations(StringBuilder builder)
public ArrayType	Returns: an `ArrayType` asArrayType() Casts this type to an `org.jboss.jandex.ArrayType` and returns it if the kind is `Kind#ARRAY`.
public ClassType	Returns: a `ClassType` asClassType() Casts this type to a `org.jboss.jandex.ClassType` and returns it if the kind is `Kind#CLASS`.
public ParameterizedType	Returns: a `ParameterizedType` asParameterizedType() Casts this type to a `org.jboss.jandex.ParameterizedType` and returns it if the kind is `Kind#PARAMETERIZED_TYPE`.
public PrimitiveType	Returns: a `PrimitiveType` asPrimitiveType() Casts this type to a `org.jboss.jandex.PrimitiveType` and returns it if the kind is `Kind#PRIMITIVE`.
public TypeVariable	Returns: a `TypeVariable` asTypeVariable() Casts this type to a `org.jboss.jandex.TypeVariable` and returns it if the kind is `Kind#TYPE_VARIABLE`.
public TypeVariableReference	Returns: a `TypeVariableReference` asTypeVariableReference() Casts this type to a `org.jboss.jandex.TypeVariableReference` and returns it if the kind is `Kind#TYPE_VARIABLE_REFERENCE`.
public UnresolvedTypeVariable	Returns: an `UnresolvedTypeVariable` asUnresolvedTypeVariable() Casts this type to an `org.jboss.jandex.UnresolvedTypeVariable` and returns it if the kind is `Kind#UNRESOLVED_TYPE_VARIABLE`.
public VoidType	Returns: a `VoidType` asVoidType() Casts this type to a `org.jboss.jandex.VoidType` and returns it if the kind is `Kind#VOID`.
public WildcardType	Returns: a `WildcardType` asWildcardType() Casts this type to a `org.jboss.jandex.WildcardType` and returns it if the kind is `Kind#WILDCARD_TYPE`.
pack-priv abstract Type	copyType(AnnotationInstance[] newAnnotations)
public static Type	Returns: the type create(DotName the name of type to use or parse; must not be `null` name, Type.Kind the kind of type to create; must not be `null` kind) Creates a type of the specified kind and `name` in the `Class#getName()` format.
public static Type	Returns: the annotated type createWithAnnotations(DotName the name of type to use or parse; must not be `null` name, Type.Kind the kind of type to create; must not be `null` kind, AnnotationInstance[] the type annotations that should be present on the type instance; may be `null` annotations) Creates an instance of specified type with given type `annotations`.
public String	Returns: the bytecode descriptor of this type (or its erasure in case of generic types) descriptor(Function<String, Type> a substitution function from type variable identifiers to types typeVariableSubstitution) Implements org.jboss.jandex.Descriptor.descriptor. Returns the bytecode descriptor of this type (or its erasure in case of generic types).
public boolean	Returns: true if equal equals(Object the type to compare to o) Overrides java.lang.Object.equals. Compares this `Type` with another type.
public final boolean	Returns: `true` if the annotation is present, `false` otherwise hasAnnotation(DotName name of the annotation type to look for, must not be `null` name) Returns whether an annotation instance with given name is declared on this type usage.
public int	Returns: the hash code hashCode() Overrides java.lang.Object.hashCode. Computes a hash code representing this type.
pack-priv boolean	internEquals(Object o)
pack-priv int	internHashCode()
public abstract Type.Kind	Returns: the kind kind() Returns the kind of Type this is.
public DotName	Returns: the name of this type (or its erasure in case of generic types) name() Returns the name of this type (or its erasure in case of generic types) as a `DotName`, using the `Class#getName()` format.
public String	Returns: the string representation. toString() Overrides java.lang.Object.toString. Returns a string representation for this type.
pack-priv String	toString(boolean simple)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

annotations	back to summary
private final AnnotationInstance[] annotations

EMPTY_ANNOTATIONS	back to summary
private static final AnnotationInstance[] EMPTY_ANNOTATIONS

EMPTY_ARRAY	back to summary
public static final Type[] EMPTY_ARRAY

name	back to summary
private final DotName name

Constructor Detail

Type	back to summary
pack-priv Type(DotName name, AnnotationInstance[] annotations)

Method Detail

addAnnotation	back to summary
pack-priv Type addAnnotation(AnnotationInstance annotation)

annotation back to summary

annotation	back to summary
public final AnnotationInstance annotation(DotName name) Returns the annotation instance with given name declared on this type usage. To allow for `Type` object reuse, the annotation instances returned by this method have a `null` annotation target. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found

public final AnnotationInstance annotation(DotName name)

Returns the annotation instance with given name declared on this type usage.

To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

annotationArray	back to summary
pack-priv AnnotationInstance[] annotationArray()

annotations back to summary

annotations	back to summary
public List<AnnotationInstance> annotations() Returns the annotation instances declared on this type usage. To allow for `Type` object reuse, the annotation instances returned by this method have a `null` annotation target. Returns:List<AnnotationInstance> immutable list of annotation instances, never `null` Since 2.0

public List<AnnotationInstance> annotations()

Returns the annotation instances declared on this type usage.

To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.

Returns:List<AnnotationInstance>: immutable list of annotation instances, never null
Since: 2.0

annotationsWithRepeatable back to summary

annotationsWithRepeatable	back to summary
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index) Returns the annotation instances with given name declared on this type usage. If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the `AnnotationInstance#target()` returns the target of the container annotation instance. To allow for `Type` object reuse, the annotation instances returned by this method have a `null` annotation target. Parameters name:DotName name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:List<AnnotationInstance> immutable list of annotation instances, never `null` Exceptions IllegalArgumentException: if the index is `null`, if the index does not contain the annotation type or if `name` does not identify an annotation type Since 3.0 See Also `annotations()`

public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)

Returns the annotation instances with given name declared on this type usage.

If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance#target() returns the target of the container annotation instance.

To allow for Type object reuse, the annotation instances returned by this method have a null annotation target.

Parameters

name:DotName: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:List<AnnotationInstance>

immutable list of annotation instances, never null

Exceptions

IllegalArgumentException:: if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type

Since

3.0

See Also

annotations()

appendAnnotations	back to summary
pack-priv void appendAnnotations(StringBuilder builder)

asArrayType back to summary

asArrayType	back to summary
public ArrayType asArrayType() Casts this type to an `org.jboss.jandex.ArrayType` and returns it if the kind is `Kind#ARRAY`. Throws an exception otherwise. Returns:ArrayType an `ArrayType` Exceptions IllegalArgumentException: if not an array type Since 2.0

public ArrayType asArrayType()

Casts this type to an org.jboss.jandex.ArrayType and returns it if the kind is Kind#ARRAY. Throws an exception otherwise.

Returns:ArrayType

an ArrayType

Exceptions

IllegalArgumentException:: if not an array type

Since

2.0

asClassType back to summary

asClassType	back to summary
public ClassType asClassType() Casts this type to a `org.jboss.jandex.ClassType` and returns it if the kind is `Kind#CLASS`. Throws an exception otherwise. Returns:ClassType a `ClassType` Exceptions IllegalArgumentException: if not a class Since 2.0

public ClassType asClassType()

Casts this type to a org.jboss.jandex.ClassType and returns it if the kind is Kind#CLASS. Throws an exception otherwise.

Returns:ClassType

a ClassType

Exceptions

IllegalArgumentException:: if not a class

Since

2.0

asParameterizedType back to summary

asParameterizedType	back to summary
public ParameterizedType asParameterizedType() Casts this type to a `org.jboss.jandex.ParameterizedType` and returns it if the kind is `Kind#PARAMETERIZED_TYPE`. Throws an exception otherwise. Returns:ParameterizedType a `ParameterizedType` Exceptions IllegalArgumentException: if not a parameterized type Since 2.0

public ParameterizedType asParameterizedType()

Casts this type to a org.jboss.jandex.ParameterizedType and returns it if the kind is Kind#PARAMETERIZED_TYPE. Throws an exception otherwise.

Returns:ParameterizedType

a ParameterizedType

Exceptions

IllegalArgumentException:: if not a parameterized type

Since

2.0

asPrimitiveType back to summary

asPrimitiveType	back to summary
public PrimitiveType asPrimitiveType() Casts this type to a `org.jboss.jandex.PrimitiveType` and returns it if the kind is `Kind#PRIMITIVE`. Throws an exception otherwise. Returns:PrimitiveType a `PrimitiveType` Exceptions IllegalArgumentException: if not a primitive type Since 2.0

public PrimitiveType asPrimitiveType()

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

Returns:PrimitiveType

a PrimitiveType

Exceptions

IllegalArgumentException:: if not a primitive type

Since

2.0

asTypeVariable back to summary

asTypeVariable	back to summary
public TypeVariable asTypeVariable() Casts this type to a `org.jboss.jandex.TypeVariable` and returns it if the kind is `Kind#TYPE_VARIABLE`. Throws an exception otherwise. Returns:TypeVariable a `TypeVariable` Exceptions IllegalArgumentException: if not a type variable Since 2.0

public TypeVariable asTypeVariable()

Casts this type to a org.jboss.jandex.TypeVariable and returns it if the kind is Kind#TYPE_VARIABLE. Throws an exception otherwise.

Returns:TypeVariable

a TypeVariable

Exceptions

IllegalArgumentException:: if not a type variable

Since

2.0

asTypeVariableReference back to summary

asTypeVariableReference	back to summary
public TypeVariableReference asTypeVariableReference() Casts this type to a `org.jboss.jandex.TypeVariableReference` and returns it if the kind is `Kind#TYPE_VARIABLE_REFERENCE`. Throws an exception otherwise. Returns:TypeVariableReference a `TypeVariableReference` Exceptions IllegalArgumentException: if not a type variable Since 2.0

public TypeVariableReference asTypeVariableReference()

Casts this type to a org.jboss.jandex.TypeVariableReference and returns it if the kind is Kind#TYPE_VARIABLE_REFERENCE. Throws an exception otherwise.

Returns:TypeVariableReference

a TypeVariableReference

Exceptions

IllegalArgumentException:: if not a type variable

Since

2.0

asUnresolvedTypeVariable back to summary

asUnresolvedTypeVariable	back to summary
public UnresolvedTypeVariable asUnresolvedTypeVariable() Casts this type to an `org.jboss.jandex.UnresolvedTypeVariable` and returns it if the kind is `Kind#UNRESOLVED_TYPE_VARIABLE`. Throws an exception otherwise. Returns:UnresolvedTypeVariable an `UnresolvedTypeVariable` Exceptions IllegalArgumentException: if not an unresolved type Since 2.0

public UnresolvedTypeVariable asUnresolvedTypeVariable()

Casts this type to an org.jboss.jandex.UnresolvedTypeVariable and returns it if the kind is Kind#UNRESOLVED_TYPE_VARIABLE. Throws an exception otherwise.

Returns:UnresolvedTypeVariable

an UnresolvedTypeVariable

Exceptions

IllegalArgumentException:: if not an unresolved type

Since

2.0

asVoidType back to summary

asVoidType	back to summary
public VoidType asVoidType() Casts this type to a `org.jboss.jandex.VoidType` and returns it if the kind is `Kind#VOID`. Throws an exception otherwise. Returns:VoidType a `VoidType` Exceptions IllegalArgumentException: if not a void type Since 2.0

public VoidType asVoidType()

Casts this type to a org.jboss.jandex.VoidType and returns it if the kind is Kind#VOID. Throws an exception otherwise.

Returns:VoidType

a VoidType

Exceptions

IllegalArgumentException:: if not a void type

Since

2.0

asWildcardType back to summary

asWildcardType	back to summary
public WildcardType asWildcardType() Casts this type to a `org.jboss.jandex.WildcardType` and returns it if the kind is `Kind#WILDCARD_TYPE`. Throws an exception otherwise. Returns:WildcardType a `WildcardType` Exceptions IllegalArgumentException: if not a wildcard type Since 2.0

public WildcardType asWildcardType()

Casts this type to a org.jboss.jandex.WildcardType and returns it if the kind is Kind#WILDCARD_TYPE. Throws an exception otherwise.

Returns:WildcardType

a WildcardType

Exceptions

IllegalArgumentException:: if not a wildcard type

Since

2.0

copyType	back to summary
pack-priv abstract Type copyType(AnnotationInstance[] newAnnotations)

create back to summary

create	back to summary
public static Type create(DotName name, Type.Kind kind) Creates a type of the specified kind and `name` in the `Class#getName()` format. Specifically: if `kind` is `VOID`, the `name` is ignored; if `kind` is `PRIMITIVE`, the name must be the corresponding Java keyword (`boolean`, `byte`, `short`, `int`, `long`, `float`, `double`, `char`); if `kind` is `CLASS`, the `name` must be a binary name of the class; if `kind` is `ARRAY`, the `name` must consists of one or more `[` characters corresponding to the number of dimensions of the array type, followed by the element type as a single-character code for primitive types or `Lbinary.name.of.TheClass;` for class types (for example, `[I` for `int[]` or `[[Ljava.lang.String;` for `String[][]`); all other kinds cause an exception. Parameters name:DotName the name of type to use or parse; must not be `null` kind:Type.Kind the kind of type to create; must not be `null` Returns:Type the type Exceptions IllegalArgumentException: if the `kind` is not supported

public static Type create(DotName name, Type.Kind kind)

Creates a type of the specified kind and name in the Class#getName() format. Specifically:

if kind is VOID, the name is ignored;
if kind is PRIMITIVE, the name must be the corresponding Java keyword (boolean, byte, short, int, long, float, double, char);
if kind is CLASS, the name must be a binary name of the class;
if kind is ARRAY, the name must consists of one or more [ characters corresponding to the number of dimensions of the array type, followed by the element type as a single-character code for primitive types or Lbinary.name.of.TheClass; for class types (for example, [I for int[] or [[Ljava.lang.String; for String[][]);
all other kinds cause an exception.

Parameters

name:DotName: the name of type to use or parse; must not be null
kind:Type.Kind: the kind of type to create; must not be null

Returns:Type

the type

Exceptions

IllegalArgumentException:: if the kind is not supported

createWithAnnotations back to summary

createWithAnnotations	back to summary
public static Type createWithAnnotations(DotName name, Type.Kind kind, AnnotationInstance[] annotations) Creates an instance of specified type with given type `annotations`. To create the type instance, this method delegates to `create(DotName, Kind)`. Parameters name:DotName the name of type to use or parse; must not be `null` kind:Type.Kind the kind of type to create; must not be `null` annotations:AnnotationInstance[] the type annotations that should be present on the type instance; may be `null` Returns:Type the annotated type Exceptions IllegalArgumentException: if the `kind` is not supported

public static Type createWithAnnotations(DotName name, Type.Kind kind, AnnotationInstance[] annotations)

Creates an instance of specified type with given type annotations. To create the type instance, this method delegates to create(DotName, Kind).

Parameters

name:DotName: the name of type to use or parse; must not be null
kind:Type.Kind: the kind of type to create; must not be null
annotations:AnnotationInstance[]: the type annotations that should be present on the type instance; may be null

Returns:Type

the annotated type

Exceptions

IllegalArgumentException:: if the kind is not supported

descriptor back to summary

descriptor	back to summary
public String descriptor(Function<String, Type> typeVariableSubstitution) Implements org.jboss.jandex.Descriptor.descriptor. Returns the bytecode descriptor of this type (or its erasure in case of generic types). Specifically: for primitive types and the void pseudo-type, the single-character descriptor is returned; for class types, the `Lbinary/name/of/TheClass;` string is returned; for array types, a string is returned that consists of one or more `[` characters corresponding to the number of dimensions of the array type, followed by the descriptor of the element type (for example, `[I` for `int[]` or `[[Ljava/lang/String;` for `String[][]`); for parameterized types, the descriptor of the generic class is returned (for example, `Ljava/util/List;` for `List<String>`); for type variables, the descriptor of the first bound of the type variable is returned, or the descriptor of the `java.lang.Object` class for type variables that have no bound; for wildcard types, the descriptor of the upper bound is returned, or the descriptor of the `java.lang.Object` class if the wildcard type does not have an upper bound (for example, `Ljava/lang/Number;` for `? extends Number`). Descriptors of type variables are substituted for descriptors of types provided by the substitution function `typeVariableSubstitution`. If the substitution function returns `null` for some type variable identifier, or if it returns the type variable itself, no substitution happens and the type variable descriptor is used unmodified. Note that the return value does not come directly from bytecode. Jandex does not store the descriptor strings. Instead, the return value is reconstructed from the Jandex object model. Parameters typeVariableSubstitution:Function<String, Type> Doc from org.jboss.jandex.Descriptor.descriptor. a substitution function from type variable identifiers to types Returns:String the bytecode descriptor of this type (or its erasure in case of generic types)

public String descriptor(Function<String, Type> typeVariableSubstitution)

Implements org.jboss.jandex.Descriptor.descriptor.

Returns the bytecode descriptor of this type (or its erasure in case of generic types). Specifically:

for primitive types and the void pseudo-type, the single-character descriptor is returned;
for class types, the Lbinary/name/of/TheClass; string is returned;
for array types, a string is returned that consists of one or more [ characters corresponding to the number of dimensions of the array type, followed by the descriptor of the element type (for example, [I for int[] or [[Ljava/lang/String; for String[][]);
for parameterized types, the descriptor of the generic class is returned (for example, Ljava/util/List; for List<String>);
for type variables, the descriptor of the first bound of the type variable is returned, or the descriptor of the java.lang.Object class for type variables that have no bound;
for wildcard types, the descriptor of the upper bound is returned, or the descriptor of the java.lang.Object class if the wildcard type does not have an upper bound (for example, Ljava/lang/Number; for ? extends Number).

Descriptors of type variables are substituted for descriptors of types provided by the substitution function typeVariableSubstitution. If the substitution function returns null for some type variable identifier, or if it returns the type variable itself, no substitution happens and the type variable descriptor is used unmodified.

Note that the return value does not come directly from bytecode. Jandex does not store the descriptor strings. Instead, the return value is reconstructed from the Jandex object model.

Parameters

typeVariableSubstitution:Function<String, Type>

Doc from org.jboss.jandex.Descriptor.descriptor.

a substitution function from type variable identifiers to types

Returns:String

the bytecode descriptor of this type (or its erasure in case of generic types)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. 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. Parameters o:Object the type to compare to Returns:boolean true if equal Annotations @Override See Also `Object#equals(Object)`

public boolean equals(Object o)

Overrides java.lang.Object.equals.

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.

Parameters

o:Object: the type to compare to

Returns:boolean

true if equal

Annotations

@Override

See Also

Object#equals(Object)

hasAnnotation back to summary

hasAnnotation	back to summary
public final boolean hasAnnotation(DotName name) Returns whether an annotation instance with given name is declared on this type usage. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise See Also `annotation(DotName)`

public final boolean hasAnnotation(DotName name)

Returns whether an annotation instance with given name is declared on this type usage.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

See Also

annotation(DotName)

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Computes a hash code representing this type. Returns:int the hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Computes a hash code representing this type.

Returns:int

the hash code

Annotations

@Override

internEquals	back to summary
pack-priv boolean internEquals(Object o)

internHashCode	back to summary
pack-priv int internHashCode()

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

kind

back to summary

public abstract Type.Kind kind()

Returns the kind of Type this is.

Returns:Type.Kind: the kind

name back to summary

name	back to summary
public DotName name() Returns the name of this type (or its erasure in case of generic types) as a `DotName`, using the `Class#getName()` format. Specifically: for primitive types and the void pseudo-type, the corresponding Java keyword is returned (`void`, `boolean`, `byte`, `short`, `int`, `long`, `float`, `double`, `char`); for class types, the binary name of the class is returned; for array types, a string is returned that consists of one or more `[` characters corresponding to the number of dimensions of the array type, followed by the element type as a single-character code for primitive types or `Lbinary.name.of.TheClass;` for class types (for example, `[I` for `int[]` or `[[Ljava.lang.String;` for `String[][]`); for parameterized types, the binary name of the generic class is returned (for example, `java.util.List` for `List<String>`); for type variables, the name of the first bound of the type variable is returned, or `java.lang.Object` for type variables that have no bound; for wildcard types, the name of the upper bound is returned, or `java.lang.Object` if the wildcard type does not have an upper bound (for example, `java.lang.Number` for `? extends Number`). Returns:DotName the name of this type (or its erasure in case of generic types)

public DotName name()

Returns the name of this type (or its erasure in case of generic types) as a DotName, using the Class#getName() format. Specifically:

for primitive types and the void pseudo-type, the corresponding Java keyword is returned (void, boolean, byte, short, int, long, float, double, char);
for class types, the binary name of the class is returned;
for array types, a string is returned that consists of one or more [ characters corresponding to the number of dimensions of the array type, followed by the element type as a single-character code for primitive types or Lbinary.name.of.TheClass; for class types (for example, [I for int[] or [[Ljava.lang.String; for String[][]);
for parameterized types, the binary name of the generic class is returned (for example, java.util.List for List<String>);
for type variables, the name of the first bound of the type variable is returned, or java.lang.Object for type variables that have no bound;
for wildcard types, the name of the upper bound is returned, or java.lang.Object if the wildcard type does not have an upper bound (for example, java.lang.Number for ? extends Number).

Returns:DotName: the name of this type (or its erasure in case of generic types)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation for this type. It is similar, yet not identical to a Java source code representation. Returns:String the string representation.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String: the string representation.

toString	back to summary
pack-priv String toString(boolean simple)

org.jboss.jandex back to summary

pack-priv abstract Class Type.Builder<THIS extends Type.Builder<THIS>>

Class Inheritance

extends Object

java.lang.Object
org.jboss.jandex.Type.Builder

Known Direct Subclasses

org.jboss.jandex.TypeVariable.Builder, org.jboss.jandex.WildcardType.Builder, org.jboss.jandex.ArrayType.Builder, org.jboss.jandex.ClassType.Builder, org.jboss.jandex.ParameterizedType.Builder

Type Parameters

<THIS>: self type

Base class for type builders.

Since: 3.1.0

Field Summary

Modifier and Type	Field and Description
protected final List<AnnotationInstance>	annotations
protected final DotName	name

Constructor Summary

Access	Constructor and Description
protected	Builder(DotName name)

Method Summary

Modifier and Type	Method and Description
public THIS	Returns: this builder addAnnotation(AnnotationInstance the annotation instance; can be created using `AnnotationInstance.builder()` annotation) Adds an annotation to the type being created by this builder.
protected AnnotationInstance[]	Returns: the annotations array or `null` if no annotation was specified annotationsArray()
protected THIS	self()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotations	back to summary
protected final List<AnnotationInstance> annotations

name	back to summary
protected final DotName name

Constructor Detail

Builder	back to summary
protected Builder(DotName name)

Method Detail

addAnnotation back to summary

addAnnotation	back to summary
public THIS addAnnotation(AnnotationInstance annotation) Adds an annotation to the type being created by this builder. Note that it becomes a type annotation. Parameters annotation:AnnotationInstance the annotation instance; can be created using `AnnotationInstance.builder()` Returns:THIS this builder See Also `Type#annotations()`

public THIS addAnnotation(AnnotationInstance annotation)

Adds an annotation to the type being created by this builder. Note that it becomes a type annotation.

Parameters

annotation:AnnotationInstance: the annotation instance; can be created using AnnotationInstance.builder()

Returns:THIS

this builder

See Also

Type#annotations()

annotationsArray	back to summary
protected AnnotationInstance[] annotationsArray() Returns:AnnotationInstance[] the annotations array or `null` if no annotation was specified

self	back to summary
protected THIS self() Annotations @SuppressWarnings:unchecked

org.jboss.jandex back to summary

public final Enum Type.Kind

Class Inheritance

extends Enum<Type.Kind>

java.lang.Object
java.lang.Enum
org.jboss.jandex.Type.Kind

Represents a "kind" of Type.

Author: Jason T. Greene

Field Summary

Modifier and Type	Field and Description
public static final Type.Kind	ARRAY A Java array
public static final Type.Kind	CLASS A Java class, interface, or annotation
public static final Type.Kind	PARAMETERIZED_TYPE A generic parameterized type
public static final Type.Kind	PRIMITIVE A Java primitive (boolean, byte, short, char, int, long, float, double)
public static final Type.Kind	TYPE_VARIABLE A resolved generic type parameter or type argument
public static final Type.Kind	TYPE_VARIABLE_REFERENCE A reference to a resolved type variable occuring in the bound of a recursive type parameter
public static final Type.Kind	UNRESOLVED_TYPE_VARIABLE An unresolved type parameter or argument.
public static final Type.Kind	VOID Used to designate a Java method that returns nothing
public static final Type.Kind	WILDCARD_TYPE A generic wildcard type

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static Type.Kind	fromOrdinal(int ordinal)
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 A Java array

CLASS	back to summary
public static final Type.Kind CLASS A Java class, interface, or annotation

PARAMETERIZED_TYPE	back to summary
public static final Type.Kind PARAMETERIZED_TYPE A generic parameterized type

PRIMITIVE	back to summary
public static final Type.Kind PRIMITIVE A Java primitive (boolean, byte, short, char, int, long, float, double)

TYPE_VARIABLE	back to summary
public static final Type.Kind TYPE_VARIABLE A resolved generic type parameter or type argument

TYPE_VARIABLE_REFERENCE	back to summary
public static final Type.Kind TYPE_VARIABLE_REFERENCE A reference to a resolved type variable occuring in the bound of a recursive type parameter

UNRESOLVED_TYPE_VARIABLE	back to summary
public static final Type.Kind UNRESOLVED_TYPE_VARIABLE An unresolved type parameter or argument. This is merely a placeholder which occurs during an error condition or incomplete processing. In most cases, it need not be dealt with.

VOID	back to summary
public static final Type.Kind VOID Used to designate a Java method that returns nothing

WILDCARD_TYPE	back to summary
public static final Type.Kind WILDCARD_TYPE A generic wildcard type

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

fromOrdinal	back to summary
public static Type.Kind fromOrdinal(int ordinal)

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

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

public abstract Class Type

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class Type.Builder<THIS extends Type.Builder<THIS>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Type.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail