io.micronaut.annotation.processing

Class GenericUtils

java.lang.Object

io.micronaut.annotation.processing.GenericUtils

@Internal
public class GenericUtils
extends java.lang.Object

Utility methods for dealing with generic type signatures.

Author:

Graeme Rocher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericUtils(javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, ModelUtils modelUtils)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>	alignNewGenericsInfo(java.util.List<? extends javax.lang.model.element.TypeParameterElement> typeParameters, java.util.List<? extends javax.lang.model.type.TypeMirror> typeArguments, java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> genericsInfo) Takes the bound generic information and re-aligns for the new type.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>>	alignNewGenericsInfo(javax.lang.model.element.TypeElement typeElement, java.util.List<? extends javax.lang.model.type.TypeMirror> typeArguments, java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> genericsInfo) Takes a type element and the bound generic information and re-aligns for the new type.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>>	buildGenericTypeArgumentElementInfo(javax.lang.model.element.Element element) Builds type argument information for the given type.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	buildGenericTypeArgumentInfo(javax.lang.model.element.Element element) Builds type argument information for the given type.
protected java.util.Optional<javax.lang.model.type.TypeMirror>	getFirstTypeArgument(javax.lang.model.type.TypeMirror type) Return the first type argument for the given type mirror.
protected javax.lang.model.type.TypeMirror	interfaceGenericTypeFor(javax.lang.model.element.TypeElement element, java.lang.Class interfaceType) Finds the generic type for the given interface for the given class element.
protected javax.lang.model.type.TypeMirror	interfaceGenericTypeFor(javax.lang.model.element.TypeElement element, java.lang.String interfaceName) Finds the generic type for the given interface for the given class element.
java.util.List<? extends javax.lang.model.type.TypeMirror>	interfaceGenericTypesFor(javax.lang.model.element.TypeElement element, java.lang.String interfaceName) Finds the generic types for the given interface for the given class element.
protected java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>	resolveBoundGenerics(javax.lang.model.element.TypeElement declaringType, javax.lang.model.type.TypeMirror returnType, java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>> genericsInfo) Resolve bound types for the given return type.
protected java.util.Map<java.lang.String,java.lang.Object>	resolveBoundTypes(javax.lang.model.type.DeclaredType type) Resolve bound types for the given declared type.
protected java.util.Map<java.lang.String,java.lang.Object>	resolveGenericTypes(javax.lang.model.type.DeclaredType type, javax.lang.model.element.TypeElement typeElement, java.util.Map<java.lang.String,java.lang.Object> boundTypes) Resolve the generic type arguments for the given type mirror and bound type arguments.
protected java.util.Map<java.lang.String,java.lang.Object>	resolveGenericTypes(javax.lang.model.type.TypeMirror type, java.util.Map<java.lang.String,java.lang.Object> boundTypes) Resolve the generic type arguments for the given type mirror and bound type arguments.
protected java.lang.Object	resolveTypeReference(javax.lang.model.type.TypeMirror mirror)
protected java.lang.Object	resolveTypeReference(javax.lang.model.type.TypeMirror mirror, java.util.Map<java.lang.String,java.lang.Object> boundTypes) Resolve a type reference to use for the given type mirror taking into account generic type variables.
protected javax.lang.model.type.DeclaredType	resolveTypeVariable(javax.lang.model.element.Element element, javax.lang.model.type.TypeVariable typeVariable) Resolve the first type argument to a parameterized type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericUtils

protected GenericUtils(javax.lang.model.util.Elements elementUtils,
                       javax.lang.model.util.Types typeUtils,
                       ModelUtils modelUtils)

Parameters:

elementUtils - The Elements

typeUtils - The Types

modelUtils - The ModelUtils

Method Detail

buildGenericTypeArgumentInfo

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> buildGenericTypeArgumentInfo(@NonNull
                                                                                                                     javax.lang.model.element.Element element)

Builds type argument information for the given type.

Parameters:

element - The element

Returns:

The type argument information

buildGenericTypeArgumentElementInfo

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>> buildGenericTypeArgumentElementInfo(@NonNull
                                                                                                                                            javax.lang.model.element.Element element)

Builds type argument information for the given type.

Parameters:

element - The element

Returns:

The type argument information

interfaceGenericTypeFor

protected javax.lang.model.type.TypeMirror interfaceGenericTypeFor(javax.lang.model.element.TypeElement element,
                                                                   java.lang.Class interfaceType)

Finds the generic type for the given interface for the given class element.

For example, for class AProvider implements Provider element = AProvider interfaceType = interface javax.inject.Provider.class return A

Parameters:

element - The class element

interfaceType - The interface

Returns:

The generic type or null

interfaceGenericTypeFor

protected javax.lang.model.type.TypeMirror interfaceGenericTypeFor(javax.lang.model.element.TypeElement element,
                                                                   java.lang.String interfaceName)

Finds the generic type for the given interface for the given class element.

For example, for class AProvider implements Provider<A> element = AProvider interfaceName = interface javax.inject.Provider return A

Parameters:

element - The class element

interfaceName - The interface

Returns:

The generic type or null

interfaceGenericTypesFor

public java.util.List<? extends javax.lang.model.type.TypeMirror> interfaceGenericTypesFor(javax.lang.model.element.TypeElement element,
                                                                                           java.lang.String interfaceName)

Finds the generic types for the given interface for the given class element.

Parameters:

element - The class element

interfaceName - The interface

Returns:

The generic types or an empty list

getFirstTypeArgument

protected java.util.Optional<javax.lang.model.type.TypeMirror> getFirstTypeArgument(javax.lang.model.type.TypeMirror type)

Return the first type argument for the given type mirror. For example for Optional<String> this will return String.

Parameters:

type - The type

Returns:

The first argument.

resolveGenericTypes

protected java.util.Map<java.lang.String,java.lang.Object> resolveGenericTypes(javax.lang.model.type.TypeMirror type,
                                                                               java.util.Map<java.lang.String,java.lang.Object> boundTypes)

Resolve the generic type arguments for the given type mirror and bound type arguments.

Parameters:

type - The type mirror

boundTypes - The bound types (such as those declared on the class)

Returns:

A map of generic type arguments

resolveGenericTypes

protected java.util.Map<java.lang.String,java.lang.Object> resolveGenericTypes(javax.lang.model.type.DeclaredType type,
                                                                               javax.lang.model.element.TypeElement typeElement,
                                                                               java.util.Map<java.lang.String,java.lang.Object> boundTypes)

Resolve the generic type arguments for the given type mirror and bound type arguments.

Parameters:

type - The declaring type

typeElement - The type element

boundTypes - The bound types

Returns:

A map of generic type arguments

resolveTypeReference

protected java.lang.Object resolveTypeReference(javax.lang.model.type.TypeMirror mirror)

Parameters:

mirror - The TypeMirror

Returns:

The resolved type reference

resolveTypeReference

protected java.lang.Object resolveTypeReference(javax.lang.model.type.TypeMirror mirror,
                                                java.util.Map<java.lang.String,java.lang.Object> boundTypes)

Resolve a type reference to use for the given type mirror taking into account generic type variables.

Parameters:

mirror - The mirror

boundTypes - The already bound types for any type variable

Returns:

A type reference

resolveTypeVariable

protected javax.lang.model.type.DeclaredType resolveTypeVariable(javax.lang.model.element.Element element,
                                                                 javax.lang.model.type.TypeVariable typeVariable)

Resolve the first type argument to a parameterized type.

Parameters:

element - The type element

typeVariable - The type variable

Returns:

The declaring type

resolveBoundTypes

protected java.util.Map<java.lang.String,java.lang.Object> resolveBoundTypes(javax.lang.model.type.DeclaredType type)

Resolve bound types for the given declared type.

Parameters:

type - The declaring type

Returns:

The type bounds

resolveBoundGenerics

protected java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> resolveBoundGenerics(javax.lang.model.element.TypeElement declaringType,
                                                                                                javax.lang.model.type.TypeMirror returnType,
                                                                                                java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>> genericsInfo)

Resolve bound types for the given return type.

Parameters:

declaringType - The declaring type

returnType - The return type

genericsInfo - The declaring generics info

Returns:

The type bounds

alignNewGenericsInfo

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>> alignNewGenericsInfo(javax.lang.model.element.TypeElement typeElement,
                                                                                                                             java.util.List<? extends javax.lang.model.type.TypeMirror> typeArguments,
                                                                                                                             java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> genericsInfo)

Takes a type element and the bound generic information and re-aligns for the new type.

Parameters:

typeElement - The type element

typeArguments - The type arguments

genericsInfo - The generic info

Returns:

The aligned generics

alignNewGenericsInfo

public java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> alignNewGenericsInfo(java.util.List<? extends javax.lang.model.element.TypeParameterElement> typeParameters,
                                                                                             java.util.List<? extends javax.lang.model.type.TypeMirror> typeArguments,
                                                                                             java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> genericsInfo)

Takes the bound generic information and re-aligns for the new type.

Parameters:

typeParameters - The type parameters

typeArguments - The type arguments

genericsInfo - The generic info

Returns:

The aligned generics