Type (MapStruct Processor 1.4.0.Final API)

java.lang.Object
- org.mapstruct.ap.internal.writer.FreeMarkerWritable
- - org.mapstruct.ap.internal.model.common.ModelElement
  - - org.mapstruct.ap.internal.model.common.Type

All Implemented Interfaces:

Comparable<Type>, Writable
```
public class Type
extends ModelElement
implements Comparable<Type>
```
Represents (a reference to) the type of a bean property, parameter etc. Types are managed per generated source file. Each type corresponds to a TypeMirror, i.e. there are different instances for e.g. Set<String> and Set<Integer>.
Allows for a unified handling of declared and primitive types and usage within templates. Instances are obtained through TypeFactory.

Author:

Gunnar Morling

Nested Class Summary
- Nested classes/interfaces inherited from interface org.mapstruct.ap.internal.writer.Writable
  Writable.Context

Constructor Summary

Constructors
Constructor and Description
Type(Types typeUtils, Elements elementUtils, TypeFactory typeFactory, AccessorNamingUtils accessorNaming, TypeMirror typeMirror, TypeElement typeElement, List<Type> typeParameters, ImplementationType implementationType, Type componentType, String packageName, String name, String qualifiedName, boolean isInterface, boolean isEnumType, boolean isIterableType, boolean isCollectionType, boolean isMapType, boolean isStreamType, Map<String,String> toBeImportedTypes, Map<String,String> notToBeImportedTypes, Boolean isToBeImported, boolean isLiteral, boolean loggingVerbose)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canAccess(Type type, ExecutableElement method)`
`int`	`compareTo(Type o)`
`String`	`createReferenceName()` Returns a String that could be used in generated code to reference to this `Type`.
`String`	`describe()`
`List<Type>`	`determineTypeArguments(Class<?> superclass)` Searches for the given superclass and collects all type arguments for the given class
`int`	`distanceTo(Type assignableOther)` Returns the length of the shortest path in the type hierarchy between this type and the specified other type.
`boolean`	`equals(Object obj)`
`Type`	`erasure()`
`Type`	`getComponentType()`
`List<String>`	`getEnumConstants()`
`String`	`getFullyQualifiedName()`
`String`	`getIdentification()`
`ImplementationType`	`getImplementation()`
`Type`	`getImplementationType()` Returns the implementation type to be instantiated in case this type is an interface iterable, collection or map type.
`String`	`getImportName()`
`Set<Type>`	`getImportTypes()` Returns a set containing those `Type`s referenced by this model element for which an import statement needs to be declared.
`String`	`getName()`
`String`	`getNull()`
`String`	`getPackageName()`
`Map<String,Accessor>`	`getPropertyPresenceCheckers()` getPropertyPresenceCheckers
`Map<String,Accessor>`	`getPropertyReadAccessors()` getPropertyReadAccessors
`Map<String,Accessor>`	`getPropertyWriteAccessors(org.mapstruct.ap.internal.gem.CollectionMappingStrategyGem cmStrategy)` getPropertyWriteAccessors returns a map of the write accessors according to the CollectionMappingStrategy.
`List<Element>`	`getRecordComponents()`
`String`	`getSensibleDefault()`
`Type`	`getTypeBound()` Establishes the type bound: `<? extends Number>`, returns Number `<? super Number>`, returns Number `<?>`, returns Object `<T extends Number>, returns Number`
`TypeElement`	`getTypeElement()`
`TypeMirror`	`getTypeMirror()`
`List<Type>`	`getTypeParameters()`
`boolean`	`hasAccessibleConstructor()`
`int`	`hashCode()`
`boolean`	`isAbstract()`
`boolean`	`isArrayType()`
`boolean`	`isAssignableTo(Type other)` Whether this type is assignable to the given other type.
`boolean`	`isCollectionOrMapType()`
`boolean`	`isCollectionType()`
`boolean`	`isEnumType()`
`boolean`	`isInterface()`
`boolean`	`isIterableOrStreamType()` Whether this type is a sub-type of`Iterable`, `Stream` or an array type
`boolean`	`isIterableType()` Whether this type is a sub-type of `Iterable` or an array type.
`boolean`	`isJavaLangType()`
`boolean`	`isLiteral()`
`boolean`	`isMapType()`
`boolean`	`isNative()` All primitive types and their corresponding boxed types are considered native.
`boolean`	`isPrimitive()`
`boolean`	`isRawAssignableTo(Type other)` Whether this type is raw assignable to the given other type.
`boolean`	`isRecord()`
`boolean`	`isStreamType()` Whether this type is a sub-type of `Stream`.
`boolean`	`isString()`
`boolean`	`isToBeImported()` Whether this type is to be imported by means of an import statement in the currently generated source file (it can be referenced in the generated source using its simple name) or not (referenced using the FQN).
`boolean`	`isTypeVar()`
`boolean`	`isVoid()`
`boolean`	`isWildCardExtendsBound()`
`boolean`	`isWildCardSuperBound()`
`Type`	`resolveTypeVarToType(Type declaredType, Type parameterizedType)` Steps through the declaredType in order to find a match for this typevar Type.
`String`	`toString()`
`Type`	`withoutBounds()`

Methods inherited from class org.mapstruct.ap.internal.writer.FreeMarkerWritable
getTemplateName, getTemplateNameForClass, write

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Type
```
public Type(Types typeUtils,
            Elements elementUtils,
            TypeFactory typeFactory,
            AccessorNamingUtils accessorNaming,
            TypeMirror typeMirror,
            TypeElement typeElement,
            List<Type> typeParameters,
            ImplementationType implementationType,
            Type componentType,
            String packageName,
            String name,
            String qualifiedName,
            boolean isInterface,
            boolean isEnumType,
            boolean isIterableType,
            boolean isCollectionType,
            boolean isMapType,
            boolean isStreamType,
            Map<String,String> toBeImportedTypes,
            Map<String,String> notToBeImportedTypes,
            Boolean isToBeImported,
            boolean isLiteral,
            boolean loggingVerbose)
```
- Method Detail
  - getTypeMirror
```
public TypeMirror getTypeMirror()
```
  - getTypeElement
```
public TypeElement getTypeElement()
```
  - getPackageName
```
public String getPackageName()
```
  - getName
```
public String getName()
```
  - createReferenceName
```
public String createReferenceName()
```
    Returns a String that could be used in generated code to reference to this Type.
    
    The first time a name is referred-to it will be marked as to be imported. For instance LocalDateTime can be one of java.time.LocalDateTime and org.joda.LocalDateTime)
    If the java.time variant is referred to first, the java.time.LocalDateTime will be imported and the org.joda variant will be referred to with its FQN.
    
    Returns:
    
    Just the name if this Type will be imported, otherwise the fully-qualified name.
  - getTypeParameters
```
public List<Type> getTypeParameters()
```
  - getComponentType
```
public Type getComponentType()
```
  - isPrimitive
```
public boolean isPrimitive()
```
  - isInterface
```
public boolean isInterface()
```
  - isEnumType
```
public boolean isEnumType()
```
  - isVoid
```
public boolean isVoid()
```
  - isAbstract
```
public boolean isAbstract()
```
  - isString
```
public boolean isString()
```
  - getEnumConstants
```
public List<String> getEnumConstants()
```
    Returns:
    
    this type's enum constants in case it is an enum, an empty list otherwise.
  - getImplementationType
```
public Type getImplementationType()
```
    Returns the implementation type to be instantiated in case this type is an interface iterable, collection or map type. The type will have the correct type arguments, so if this type e.g. represents Set<String>, the implementation type is HashSet<String>.
    
    Returns:
    
    The implementation type to be instantiated in case this type is an interface iterable, collection or map type, null otherwise.
  - getImplementation
```
public ImplementationType getImplementation()
```
  - isIterableType
```
public boolean isIterableType()
```
    Whether this type is a sub-type of Iterable or an array type.
    
    Returns:
    
    true if this type is a sub-type of Iterable or an array type, false otherwise.
  - isIterableOrStreamType
```
public boolean isIterableOrStreamType()
```
    Whether this type is a sub-type ofIterable, Stream or an array type
    
    Returns:
    
    true if this type is a sub-type ofIterable, Stream or an array type, false otherwise
  - isCollectionType
```
public boolean isCollectionType()
```
  - isMapType
```
public boolean isMapType()
```
  - isCollectionOrMapType
```
public boolean isCollectionOrMapType()
```
  - isArrayType
```
public boolean isArrayType()
```
  - isTypeVar
```
public boolean isTypeVar()
```
  - isJavaLangType
```
public boolean isJavaLangType()
```
  - isRecord
```
public boolean isRecord()
```
  - isStreamType
```
public boolean isStreamType()
```
    Whether this type is a sub-type of Stream.
    
    Returns:
    
    true it this type is a sub-type of Stream, false otherwise
  - isWildCardSuperBound
```
public boolean isWildCardSuperBound()
```
  - isWildCardExtendsBound
```
public boolean isWildCardExtendsBound()
```
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
  - getImportName
```
public String getImportName()
```
    Returns:
    
    The name of this type as to be used within import statements.
  - getImportTypes
```
public Set<Type> getImportTypes()
```
    Description copied from class: ModelElement
    
    Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
    
    Specified by:
    
    getImportTypes in class ModelElement
    
    Returns:
    
    A set with type referenced by this model element. Must not be null.
  - isToBeImported
```
public boolean isToBeImported()
```
    Whether this type is to be imported by means of an import statement in the currently generated source file (it can be referenced in the generated source using its simple name) or not (referenced using the FQN).
    
    Returns:
    
    true if the type is imported, false otherwise.
  - erasure
```
public Type erasure()
```
  - withoutBounds
```
public Type withoutBounds()
```
  - isAssignableTo
```
public boolean isAssignableTo(Type other)
```
    Whether this type is assignable to the given other type.
    
    Parameters:
    
    other - The other type.
    
    Returns:
    
    true if and only if this type is assignable to the given other type.
  - isRawAssignableTo
```
public boolean isRawAssignableTo(Type other)
```
    Whether this type is raw assignable to the given other type. We can't make a verdict on typevars, they need to be resolved first.
    
    Parameters:
    
    other - The other type.
    
    Returns:
    
    true if and only if this type is assignable to the given other type.
  - getPropertyReadAccessors
```
public Map<String,Accessor> getPropertyReadAccessors()
```
    getPropertyReadAccessors
    
    Returns:
    
    an unmodifiable map of all read accessors (including 'is' for booleans), indexed by property name
  - getPropertyPresenceCheckers
```
public Map<String,Accessor> getPropertyPresenceCheckers()
```
    getPropertyPresenceCheckers
    
    Returns:
    
    an unmodifiable map of all presence checkers, indexed by property name
  - getPropertyWriteAccessors
```
public Map<String,Accessor> getPropertyWriteAccessors(org.mapstruct.ap.internal.gem.CollectionMappingStrategyGem cmStrategy)
```
    getPropertyWriteAccessors returns a map of the write accessors according to the CollectionMappingStrategy. These accessors include:
    - setters, the obvious candidate :-), getSetters()
    - readAccessors, for collections that do not have a setter, e.g. for JAXB generated collection attributes getPropertyReadAccessors()
    - adders, typically for from table generated entities, getAdders()
    Parameters:
    
    cmStrategy - collection mapping strategy
    
    Returns:
    
    an unmodifiable map of all write accessors indexed by property name
  - getRecordComponents
```
public List<Element> getRecordComponents()
```
  - distanceTo
```
public int distanceTo(Type assignableOther)
```
    Returns the length of the shortest path in the type hierarchy between this type and the specified other type. Returns -1 if this type is not assignable to the other type. Returns 0 if this type is equal to the other type. Returns 1, if the other type is a direct super type of this type, and so on.
    
    Parameters:
    
    assignableOther - the other type
    
    Returns:
    
    the length of the shortest path in the type hierarchy between this type and the specified other type
  - canAccess
```
public boolean canAccess(Type type,
                         ExecutableElement method)
```
    Parameters:
    
    type - the type declaring the method
    
    method - the method to check
    
    Returns:
    
    Whether this type can access the given method declared on the given type.
  - getNull
```
public String getNull()
```
    Returns:
    
    A valid Java expression most suitable for representing null - useful for dealing with primitives from FTL.
  - getSensibleDefault
```
public String getSensibleDefault()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(Type o)
```
    Specified by:
    
    compareTo in interface Comparable<Type>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - describe
```
public String describe()
```
    Returns:
    
    a string representation of the type for use in messages
  - getIdentification
```
public String getIdentification()
```
    Returns:
    
    an identification that can be used as part in a forged method name.
  - getTypeBound
```
public Type getTypeBound()
```
    Establishes the type bound:
    1. <? extends Number>, returns Number
    2. <? super Number>, returns Number
    3. <?>, returns Object
    4. <T extends Number>, returns Number
    Returns:
    
    the bound for this parameter
  - hasAccessibleConstructor
```
public boolean hasAccessibleConstructor()
```
  - determineTypeArguments
```
public List<Type> determineTypeArguments(Class<?> superclass)
```
    Searches for the given superclass and collects all type arguments for the given class
    
    Parameters:
    
    superclass - the superclass or interface the generic type arguments are searched for
    
    Returns:
    
    a list of type arguments or null, if superclass was not found
  - isNative
```
public boolean isNative()
```
    All primitive types and their corresponding boxed types are considered native.
    
    Returns:
    
    true when native.
  - isLiteral
```
public boolean isLiteral()
```
  - resolveTypeVarToType
```
public Type resolveTypeVarToType(Type declaredType,
                                 Type parameterizedType)
```
    Steps through the declaredType in order to find a match for this typevar Type. It allignes with the provided parameterized type where this typeVar type is used.
    
    Parameters:
    
    declaredType - the type
    
    parameterizedType - the parameterized type
    
    Returns:
    
    the matching declared type.

Class Type

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapstruct.ap.internal.writer.Writable

Constructor Summary

Method Summary

Methods inherited from class org.mapstruct.ap.internal.writer.FreeMarkerWritable

Methods inherited from class java.lang.Object

Constructor Detail

Type

Method Detail

getTypeMirror

getTypeElement

getPackageName

getName

createReferenceName

getTypeParameters

getComponentType

isPrimitive

isInterface

isEnumType

isVoid

isAbstract

isString

getEnumConstants

getImplementationType

getImplementation

isIterableType

isIterableOrStreamType

isCollectionType

isMapType

isCollectionOrMapType

isArrayType

isTypeVar

isJavaLangType

isRecord

isStreamType

isWildCardSuperBound

isWildCardExtendsBound

getFullyQualifiedName

getImportName

getImportTypes

isToBeImported

erasure

withoutBounds

isAssignableTo

isRawAssignableTo

getPropertyReadAccessors

getPropertyPresenceCheckers

getPropertyWriteAccessors

getRecordComponents

distanceTo

canAccess

getNull

getSensibleDefault

hashCode

equals

compareTo

toString

describe

getIdentification

getTypeBound

hasAccessibleConstructor

determineTypeArguments

isNative

isLiteral

resolveTypeVarToType