Represents a parameterized type. The name() denotes the generic class, and arguments() is a list of type arguments applied to the generic class in order to instantiate this parameterized type.

For example, the parameterized type Map<String, Integer> would have a name of java.util.Map and two ClassType arguments: java.lang.String and java.lang.Integer.

Additionally, a parameterized type is used to represent an inner type whose enclosing type is either parameterized or has type annotations. In this case, the owner() method returns the type of the enclosing class. Such inner type may itself be parameterized.

For example, assume the following declarations:

class A<T> {
    class B {
    }
}

class C {
    class D {
    }
}

Then, the type A<String>.B is reprezented as a parameterized type, even though B is not parameterized, because the enclosing type is parameterized. The owner of this type is the parameterized type A<String>.

Similarly, the type @TypeAnn C.D is reprezented as a parameterized type, even though neither C nor D are parameterized, because the enclosing type has a type annotation. The owner of this type is the class type @TypeAnn C.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ParameterizedType.Builder Convenient builder for `ParameterizedType`.

Field Summary

Modifier and Type	Field and Description
private final Type[]	arguments
private int	hash
private final Type	owner

Inherited from org.jboss.jandex.Type:: EMPTY_ARRAY

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public List<Type>	Returns: the list of type arguments, or empty if none arguments() Returns the list of type arguments used to instantiate this parameterized type.
pack-priv Type[]	argumentsArray()
public ParameterizedType	asParameterizedType() Overrides org.jboss.jandex.Type.asParameterizedType. Casts this type to a `org.jboss.jandex.ParameterizedType` and returns it if the kind is `Kind#PARAMETERIZED_TYPE`.
public static ParameterizedType.Builder	Returns: the builder builder(DotName binary name of the generic class name) Create a builder of a parameterized type with the given `name`.
public static ParameterizedType.Builder	Returns: the builder builder(Class<?> the generic class clazz) Create a builder of a parameterized type for the given generic class.
pack-priv ParameterizedType	copyType(AnnotationInstance[] newAnnotations) Implements abstract org.jboss.jandex.Type.copyType.
pack-priv ParameterizedType	copyType(Type[] arguments)
pack-priv ParameterizedType	copyType(int argumentIndex, Type argument)
pack-priv ParameterizedType	copyType(Type owner)
public static ParameterizedType	Returns: the parameterized type create(DotName the binary name of the generic class name, Type... type arguments applied to the generic class to form the parameterized type arguments) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`.
public static ParameterizedType	Returns: the parameterized type create(String the binary name of the generic class name, Type... type arguments applied to the generic class to form the parameterized type arguments) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`.
public static ParameterizedType	Returns: the parameterized type create(Class<?> the generic class clazz, Type... type arguments applied to the generic class to form the parameterized type arguments) Create an instance of a parameterized type with given generic `clazz` and given type `arguments`.
public static ParameterizedType	Returns: the parameterized type create(DotName the binary name of the generic class name, Type[] an array of type arguments applied to a generic class to form the parameterized type arguments, Type the enclosing type if annotated or parameterized, otherwise `null` owner) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`.
public static ParameterizedType	Returns: the parameterized type create(String the binary name of the generic class name, Type[] an array of type arguments applied to a generic class to form the parameterized type arguments, Type the enclosing type if annotated or parameterized, otherwise `null` owner) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`.
public static ParameterizedType	Returns: the parameterized type create(Class<?> the generic class clazz, Type[] an array of type arguments applied to a generic class to form the parameterized type arguments, Type the enclosing type if annotated or parameterized, otherwise `null` owner) Create an instance of a parameterized type with given generic `clazz` and given type `arguments`.
public boolean	equals(Object the type to compare to o) Overrides org.jboss.jandex.Type.equals. Compares this `Type` with another type.
public int	hashCode() Overrides org.jboss.jandex.Type.hashCode. Computes a hash code representing this type.
pack-priv boolean	internEquals(Object o) Overrides org.jboss.jandex.Type.internEquals.
pack-priv int	internHashCode() Overrides org.jboss.jandex.Type.internHashCode.
public Type.Kind	kind() Implements abstract org.jboss.jandex.Type.kind. Returns the kind of Type this is.
public Type	Returns: the owner type if the owner is parameterized or annotated, otherwise null owner() Returns the owner (enclosing) type of this parameterized type, if the owner is parameterized or has type annotations.
pack-priv String	toString(boolean simple) Overrides org.jboss.jandex.Type.toString.

Field Detail

arguments	back to summary
private final Type[] arguments

hash	back to summary
private int hash

owner	back to summary
private final Type owner

Constructor Detail

ParameterizedType	back to summary
pack-priv ParameterizedType(DotName name, Type[] arguments, Type owner)

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

Method Detail

arguments	back to summary
public List<Type> arguments() Returns the list of type arguments used to instantiate this parameterized type. Returns:List<Type> the list of type arguments, or empty if none

arguments

back to summary

public List<Type> arguments()

Returns the list of type arguments used to instantiate this parameterized type.

Returns:List<Type>: the list of type arguments, or empty if none

argumentsArray	back to summary
pack-priv Type[] argumentsArray()

asParameterizedType back to summary

asParameterizedType	back to summary
public ParameterizedType asParameterizedType() Overrides org.jboss.jandex.Type.asParameterizedType. Doc from org.jboss.jandex.Type.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` Annotations @Override

public ParameterizedType asParameterizedType()

Overrides org.jboss.jandex.Type.asParameterizedType.

Doc from org.jboss.jandex.Type.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

Annotations

@Override

builder back to summary

builder	back to summary
public static ParameterizedType.Builder builder(DotName name) Create a builder of a parameterized type with the given `name`. Parameters name:DotName binary name of the generic class Returns:ParameterizedType.Builder the builder Since 3.1.0

public static ParameterizedType.Builder builder(DotName name)

Create a builder of a parameterized type with the given name.

Parameters

name:DotName: binary name of the generic class

Returns:ParameterizedType.Builder

the builder

Since

3.1.0

builder	back to summary
public static ParameterizedType.Builder builder(Class<?> clazz) Create a builder of a parameterized type for the given generic class. Parameters clazz:Class<?> the generic class Returns:ParameterizedType.Builder the builder Since 3.1.0

builder

back to summary

public static ParameterizedType.Builder builder(Class<?> clazz)

Create a builder of a parameterized type for the given generic class.

Parameters

clazz:Class<?>: the generic class

Returns:ParameterizedType.Builder

the builder

Since

3.1.0

copyType	back to summary
pack-priv ParameterizedType copyType(AnnotationInstance[] newAnnotations) Implements abstract org.jboss.jandex.Type.copyType. Annotations @Override

copyType

back to summary

pack-priv ParameterizedType copyType(AnnotationInstance[] newAnnotations)

Implements abstract org.jboss.jandex.Type.copyType.

Annotations

@Override

copyType	back to summary
pack-priv ParameterizedType copyType(Type[] arguments)

copyType	back to summary
pack-priv ParameterizedType copyType(int argumentIndex, Type argument)

copyType	back to summary
pack-priv ParameterizedType copyType(Type owner)

create back to summary

create	back to summary
public static ParameterizedType create(DotName name, Type... arguments) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`. The resulting parameterized type has no owner. Parameters name:DotName the binary name of the generic class arguments:Type[] type arguments applied to the generic class to form the parameterized type Returns:ParameterizedType the parameterized type Since 3.1.0

public static ParameterizedType create(DotName name, Type... arguments)

Create an instance of a parameterized type with given name, which denotes a generic class, and given type arguments.

The resulting parameterized type has no owner.

Parameters

name:DotName: the binary name of the generic class
arguments:Type[]: type arguments applied to the generic class to form the parameterized type

Returns:ParameterizedType

the parameterized type

Since

3.1.0

create back to summary

create	back to summary
public static ParameterizedType create(String name, Type... arguments) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`. The resulting parameterized type has no owner. Parameters name:String the binary name of the generic class arguments:Type[] type arguments applied to the generic class to form the parameterized type Returns:ParameterizedType the parameterized type Since 3.1.0

public static ParameterizedType create(String name, Type... arguments)

Create an instance of a parameterized type with given name, which denotes a generic class, and given type arguments.

The resulting parameterized type has no owner.

Parameters

name:String: the binary name of the generic class
arguments:Type[]: type arguments applied to the generic class to form the parameterized type

Returns:ParameterizedType

the parameterized type

Since

3.1.0

create back to summary

create	back to summary
public static ParameterizedType create(Class<?> clazz, Type... arguments) Create an instance of a parameterized type with given generic `clazz` and given type `arguments`. The resulting parameterized type has no owner. Parameters clazz:Class<?> the generic class arguments:Type[] type arguments applied to the generic class to form the parameterized type Returns:ParameterizedType the parameterized type Since 3.1.0

public static ParameterizedType create(Class<?> clazz, Type... arguments)

Create an instance of a parameterized type with given generic clazz and given type arguments.

The resulting parameterized type has no owner.

Parameters

clazz:Class<?>: the generic class
arguments:Type[]: type arguments applied to the generic class to form the parameterized type

Returns:ParameterizedType

the parameterized type

Since

3.1.0

create back to summary

create	back to summary
public static ParameterizedType create(DotName name, Type[] arguments, Type owner) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`. An `owner` may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation. Parameters name:DotName the binary name of the generic class arguments:Type[] an array of type arguments applied to a generic class to form the parameterized type owner:Type the enclosing type if annotated or parameterized, otherwise `null` Returns:ParameterizedType the parameterized type Since 2.1

public static ParameterizedType create(DotName name, Type[] arguments, Type owner)

Create an instance of a parameterized type with given name, which denotes a generic class, and given type arguments.

An owner may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation.

Parameters

name:DotName: the binary name of the generic class
arguments:Type[]: an array of type arguments applied to a generic class to form the parameterized type
owner:Type: the enclosing type if annotated or parameterized, otherwise null

Returns:ParameterizedType

the parameterized type

Since

2.1

create back to summary

create	back to summary
public static ParameterizedType create(String name, Type[] arguments, Type owner) Create an instance of a parameterized type with given `name`, which denotes a generic class, and given type `arguments`. An `owner` may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation. Parameters name:String the binary name of the generic class arguments:Type[] an array of type arguments applied to a generic class to form the parameterized type owner:Type the enclosing type if annotated or parameterized, otherwise `null` Returns:ParameterizedType the parameterized type Since 3.1.0

public static ParameterizedType create(String name, Type[] arguments, Type owner)

Create an instance of a parameterized type with given name, which denotes a generic class, and given type arguments.

An owner may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation.

Parameters

name:String: the binary name of the generic class
arguments:Type[]: an array of type arguments applied to a generic class to form the parameterized type
owner:Type: the enclosing type if annotated or parameterized, otherwise null

Returns:ParameterizedType

the parameterized type

Since

3.1.0

create back to summary

create	back to summary
public static ParameterizedType create(Class<?> clazz, Type[] arguments, Type owner) Create an instance of a parameterized type with given generic `clazz` and given type `arguments`. An `owner` may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation. Parameters clazz:Class<?> the generic class arguments:Type[] an array of type arguments applied to a generic class to form the parameterized type owner:Type the enclosing type if annotated or parameterized, otherwise `null` Returns:ParameterizedType the parameterized type Since 3.1.0

public static ParameterizedType create(Class<?> clazz, Type[] arguments, Type owner)

Create an instance of a parameterized type with given generic clazz and given type arguments.

An owner may be supplied when the new instance is supposed to represent an inner type whose enclosing type is either parameterized or annotated with a type annotation.

Parameters

clazz:Class<?>: the generic class
arguments:Type[]: an array of type arguments applied to a generic class to form the parameterized type
owner:Type: the enclosing type if annotated or parameterized, otherwise null

Returns:ParameterizedType

the parameterized type

Since

3.1.0

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides org.jboss.jandex.Type.equals. Doc from org.jboss.jandex.Type.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

public boolean equals(Object o)

Overrides org.jboss.jandex.Type.equals.

Doc from org.jboss.jandex.Type.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

hashCode	back to summary
public int hashCode() Overrides org.jboss.jandex.Type.hashCode. Doc from org.jboss.jandex.Type.hashCode. Computes a hash code representing this type. Returns:int the hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides org.jboss.jandex.Type.hashCode.

Doc from org.jboss.jandex.Type.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) Overrides org.jboss.jandex.Type.internEquals. Annotations @Override

internEquals

back to summary

pack-priv boolean internEquals(Object o)

Overrides org.jboss.jandex.Type.internEquals.

Annotations

@Override

internHashCode	back to summary
pack-priv int internHashCode() Overrides org.jboss.jandex.Type.internHashCode. Annotations @Override

internHashCode

back to summary

pack-priv int internHashCode()

Overrides org.jboss.jandex.Type.internHashCode.

Annotations

@Override

kind	back to summary
public Type.Kind kind() Implements abstract org.jboss.jandex.Type.kind. Doc from org.jboss.jandex.Type.kind. Returns the kind of Type this is. Returns:Type.Kind the kind Annotations @Override

kind

back to summary

public Type.Kind kind()

Implements abstract org.jboss.jandex.Type.kind.

Doc from org.jboss.jandex.Type.kind.

Returns the kind of Type this is.

Returns:Type.Kind

the kind

Annotations

@Override

owner back to summary

owner	back to summary
public Type owner() Returns the owner (enclosing) type of this parameterized type, if the owner is parameterized or has type annotations. In the latter case, the owner may be a `ClassType`. Returns `null` otherwise. Note that parameterized inner classes whose enclosing types are not parameterized or type-annotated have no owner and hence this method returns `null` in such case. This example shows the case where a parameterized type is used to represent a non-parameterized class `X`: Y<String>.X This example will return a parameterized type for `Y` when `X`'s `owner()` method is called. Returns:Type the owner type if the owner is parameterized or annotated, otherwise null

public Type owner()

Returns the owner (enclosing) type of this parameterized type, if the owner is parameterized or has type annotations. In the latter case, the owner may be a ClassType. Returns null otherwise.

Note that parameterized inner classes whose enclosing types are not parameterized or type-annotated have no owner and hence this method returns null in such case.

This example shows the case where a parameterized type is used to represent a non-parameterized class X:

Y<String>.X

This example will return a parameterized type for Y when X's owner() method is called.

Returns:Type: the owner type if the owner is parameterized or annotated, otherwise null

toString	back to summary
pack-priv String toString(boolean simple) Overrides org.jboss.jandex.Type.toString. Annotations @Override

toString

back to summary

pack-priv String toString(boolean simple)

Overrides org.jboss.jandex.Type.toString.

Annotations

@Override

org.jboss.jandex back to summary

public final Class ParameterizedType.Builder

Class Inheritance

extends Type.Builder<ParameterizedType.Builder>

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

Convenient builder for ParameterizedType.

Since: 3.1.0

Field Summary

Modifier and Type	Field and Description
private List<Type>	arguments
private Type	owner

Inherited from org.jboss.jandex.Type.Builder:: annotations name

Constructor Summary

Access	Constructor and Description
pack-priv	Builder(DotName name)

Method Summary

Modifier and Type	Method and Description
public ParameterizedType.Builder	Returns: this builder addArgument(Type the type argument, must not be `null` argument) Adds a type argument.
public ParameterizedType.Builder	Returns: this builder addArgument(Class<?> the class whose type is added as a type argument, must not be `null` clazz) Adds a `ClassType` argument for the given class.
public ParameterizedType	Returns: the built parameterized type build() Returns the built parameterized type.
public ParameterizedType.Builder	Returns: this builder setOwner(Type the owner of the parameterized type being built, must not be `null` owner) Sets the owner.

Inherited from org.jboss.jandex.Type.Builder:: addAnnotation annotationsArray self

Field Detail

arguments	back to summary
private List<Type> arguments

owner	back to summary
private Type owner

Constructor Detail

Builder	back to summary
pack-priv Builder(DotName name)

Method Detail

addArgument back to summary

addArgument	back to summary
public ParameterizedType.Builder addArgument(Type argument) Adds a type argument. Parameters argument:Type the type argument, must not be `null` Returns:ParameterizedType.Builder this builder

public ParameterizedType.Builder addArgument(Type argument)

Adds a type argument.

Parameters

argument:Type: the type argument, must not be null

Returns:ParameterizedType.Builder

this builder

addArgument back to summary

addArgument	back to summary
public ParameterizedType.Builder addArgument(Class<?> clazz) Adds a `ClassType` argument for the given class. Parameters clazz:Class<?> the class whose type is added as a type argument, must not be `null` Returns:ParameterizedType.Builder this builder

public ParameterizedType.Builder addArgument(Class<?> clazz)

Adds a ClassType argument for the given class.

Parameters

clazz:Class<?>: the class whose type is added as a type argument, must not be null

Returns:ParameterizedType.Builder

this builder

build	back to summary
public ParameterizedType build() Returns the built parameterized type. Returns:ParameterizedType the built parameterized type

build

back to summary

public ParameterizedType build()

Returns the built parameterized type.

Returns:ParameterizedType: the built parameterized type

setOwner back to summary

setOwner	back to summary
public ParameterizedType.Builder setOwner(Type owner) Sets the owner. Parameters owner:Type the owner of the parameterized type being built, must not be `null` Returns:ParameterizedType.Builder this builder See Also `ParameterizedType#owner()`

public ParameterizedType.Builder setOwner(Type owner)

Sets the owner.

Parameters

owner:Type: the owner of the parameterized type being built, must not be null

Returns:ParameterizedType.Builder

this builder

See Also

ParameterizedType#owner()

public Class ParameterizedType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ParameterizedType.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail