io.micronaut.annotation.processing

Class GenericUtils

java.lang.Object

io.micronaut.annotation.processing.GenericUtils

@Internal
public class GenericUtils
extends Object

Utility methods for dealing with generic type signatures.

Author:

Graeme Rocher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericUtils(Elements elementUtils, Types typeUtils, ModelUtils modelUtils)

Method Summary

Modifier and Type	Method and Description
Map<String,TypeMirror>	alignNewGenericsInfo(List<? extends TypeParameterElement> typeParameters, List<? extends TypeMirror> typeArguments, Map<String,TypeMirror> genericsInfo) Align new generic information for the given type parameters, type arguments and bound generics.
Map<String,Map<String,TypeMirror>>	alignNewGenericsInfo(TypeElement typeElement, List<? extends TypeMirror> typeArguments, Map<String,TypeMirror> genericsInfo) Takes a type element and the bound generic information and re-aligns for the new type.
Map<String,Map<String,TypeMirror>>	buildGenericTypeArgumentElementInfo(Element element) Builds type argument information for the given type.
Map<String,Map<String,Object>>	buildGenericTypeArgumentInfo(Element element) Builds type argument information for the given type.
protected Optional<TypeMirror>	getFirstTypeArgument(TypeMirror type) Return the first type argument for the given type mirror.
protected TypeMirror	interfaceGenericTypeFor(TypeElement element, Class interfaceType) Finds the generic type for the given interface for the given class element.
protected TypeMirror	interfaceGenericTypeFor(TypeElement element, String interfaceName) Finds the generic type for the given interface for the given class element.
List<? extends TypeMirror>	interfaceGenericTypesFor(TypeElement element, String interfaceName) Finds the generic types for the given interface for the given class element.
protected Map<String,TypeMirror>	resolveBoundGenerics(TypeElement declaringType, TypeMirror returnType, Map<String,Map<String,TypeMirror>> genericsInfo) Resolve the bound generics.
protected Map<String,Object>	resolveBoundTypes(DeclaredType type) Resolve bound types for the given declared type.
protected Map<String,Object>	resolveGenericTypes(DeclaredType type, TypeElement typeElement, Map<String,Object> boundTypes) Resolve the generic type arguments for the given type mirror and bound type arguments.
protected Map<String,Object>	resolveGenericTypes(TypeMirror type, Map<String,Object> boundTypes) Resolve the generic type arguments for the given type mirror and bound type arguments.
protected Object	resolveTypeReference(TypeMirror mirror)
protected Object	resolveTypeReference(TypeMirror mirror, Map<String,Object> boundTypes) Resolve a type reference to use for the given type mirror taking into account generic type variables.
protected DeclaredType	resolveTypeVariable(Element element, 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(Elements elementUtils,
                       Types typeUtils,
                       ModelUtils modelUtils)

Parameters:

elementUtils - The Elements

typeUtils - The Types

modelUtils - The ModelUtils

Method Detail

buildGenericTypeArgumentInfo

public Map<String,Map<String,Object>> buildGenericTypeArgumentInfo(@Nonnull
                                                                   Element element)

Builds type argument information for the given type.

Parameters:

element - The element

Returns:

The type argument information

buildGenericTypeArgumentElementInfo

public Map<String,Map<String,TypeMirror>> buildGenericTypeArgumentElementInfo(@Nonnull
                                                                              Element element)

Builds type argument information for the given type.

Parameters:

element - The element

Returns:

The type argument information

interfaceGenericTypeFor

protected TypeMirror interfaceGenericTypeFor(TypeElement element,
                                             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 TypeMirror interfaceGenericTypeFor(TypeElement element,
                                             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 List<? extends TypeMirror> interfaceGenericTypesFor(TypeElement element,
                                                           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 Optional<TypeMirror> getFirstTypeArgument(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 Map<String,Object> resolveGenericTypes(TypeMirror type,
                                                 Map<String,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 Map<String,Object> resolveGenericTypes(DeclaredType type,
                                                 TypeElement typeElement,
                                                 Map<String,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 Object resolveTypeReference(TypeMirror mirror)

Parameters:

mirror - The TypeMirror

Returns:

The resolved type reference

resolveTypeReference

protected Object resolveTypeReference(TypeMirror mirror,
                                      Map<String,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 DeclaredType resolveTypeVariable(Element element,
                                           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 Map<String,Object> resolveBoundTypes(DeclaredType type)

Resolve bound types for the given declared type.

Parameters:

type - The declaring type

Returns:

The type bounds

resolveBoundGenerics

protected Map<String,TypeMirror> resolveBoundGenerics(TypeElement declaringType,
                                                      TypeMirror returnType,
                                                      Map<String,Map<String,TypeMirror>> genericsInfo)

Resolve the bound generics.

Parameters:

declaringType - The declaring type

returnType - The return type

genericsInfo - The generics information.

Returns:

The resolved generics

alignNewGenericsInfo

public Map<String,Map<String,TypeMirror>> alignNewGenericsInfo(TypeElement typeElement,
                                                               List<? extends TypeMirror> typeArguments,
                                                               Map<String,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 Map<String,TypeMirror> alignNewGenericsInfo(List<? extends TypeParameterElement> typeParameters,
                                                   List<? extends TypeMirror> typeArguments,
                                                   Map<String,TypeMirror> genericsInfo)

Align new generic information for the given type parameters, type arguments and bound generics.

Parameters:

typeParameters - The type parameters

typeArguments - The type arguments

genericsInfo - The new generics info

Returns:

The generics info