org.mapstruct.ap.internal.model.common

Class TypeFactory

java.lang.Object

org.mapstruct.ap.internal.model.common.TypeFactory

public class TypeFactory
extends Object

Factory creating Type instances.

Author:

Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
TypeFactory(Elements elementUtils, Types typeUtils)

Method Summary

Modifier and Type	Method and Description
Type	asCollectionOrMap(Type collectionOrMap) Converts any collection type, e.g.
Type	classTypeOf(Type type) Returns the Type that represents the declared Class type of the given type.
ExecutableType	getMethodType(TypeElement includingType, ExecutableElement method) Get the ExecutableType for given method as part of usedMapper.
List<Parameter>	getParameters(ExecutableType methodType, ExecutableElement method)
List<Parameter>	getParameters(TypeElement includingType, ExecutableElement method)
Type	getReturnType(ExecutableType method)
Type	getReturnType(TypeElement includingType, ExecutableElement method)
Parameter	getSingleParameter(TypeElement includingType, ExecutableElement method)
List<Type>	getThrownTypes(ExecutableType method)
List<Type>	getThrownTypes(TypeElement includingType, ExecutableElement method)
Type	getType(Class<?> type)
Type	getType(String canonicalName)
Type	getType(TypeElement typeElement)
Type	getType(TypeMirror mirror)
TypeMirror	getTypeBound(TypeMirror typeMirror) Establishes the type bound: {@code
boolean	isTypeAvailable(String canonicalName) Determines if the type with the given full qualified name is part of the classpath

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeFactory

public TypeFactory(Elements elementUtils,
                   Types typeUtils)

Method Detail

getType

public Type getType(Class<?> type)

getType

public Type getType(String canonicalName)

isTypeAvailable

public boolean isTypeAvailable(String canonicalName)

Determines if the type with the given full qualified name is part of the classpath

Parameters:

canonicalName - Name of the type to be checked for availability

Returns:

true if the type with the given full qualified name is part of the classpath.

getType

public Type getType(TypeElement typeElement)

getType

public Type getType(TypeMirror mirror)

classTypeOf

public Type classTypeOf(Type type)

Returns the Type that represents the declared Class type of the given type. For primitive types, the boxed class will be used. Examples:

• If type represents java.lang.Integer, it will return the type that represents Class<Integer>.
• If type represents int, it will return the type that represents Class<Integer>.

Parameters:

type - the type to return the declared class type for

Returns:

the type representing Class<type>.

getMethodType

public ExecutableType getMethodType(TypeElement includingType,
                                    ExecutableElement method)

Get the ExecutableType for given method as part of usedMapper. Possibly parameterized types in method declaration will be evaluated to concrete types then.

Parameters:

includingType - the type on which's scope the method type shall be evaluated

method - the method

Returns:

the ExecutableType representing the method as part of usedMapper

getSingleParameter

public Parameter getSingleParameter(TypeElement includingType,
                                    ExecutableElement method)

getParameters

public List<Parameter> getParameters(TypeElement includingType,
                                     ExecutableElement method)

getParameters

public List<Parameter> getParameters(ExecutableType methodType,
                                     ExecutableElement method)

getReturnType

public Type getReturnType(TypeElement includingType,
                          ExecutableElement method)

getReturnType

public Type getReturnType(ExecutableType method)

getThrownTypes

public List<Type> getThrownTypes(TypeElement includingType,
                                 ExecutableElement method)

getThrownTypes

public List<Type> getThrownTypes(ExecutableType method)

asCollectionOrMap

public Type asCollectionOrMap(Type collectionOrMap)

Converts any collection type, e.g. List<T> to Collection<T> and any map type, e.g. HashMap<K,V> to Map<K,V>.

Parameters:

collectionOrMap - any collection or map type

Returns:

the type representing Collection<T> or Map<K,V>, if the argument type is a subtype of Collection<T> or of Map<K,V> respectively.

getTypeBound

public TypeMirror getTypeBound(TypeMirror typeMirror)

Establishes the type bound:

1. , returns Number
2. , returns Number
3. , returns Object

Parameters:

typeMirror - the type to return the bound for

Returns:

the bound for this parameter