Type (MapStruct Processor 1.0.0.Beta4 API)

java.lang.Object
- org.mapstruct.ap.writer.FreeMarkerWritable
- - org.mapstruct.ap.model.common.ModelElement
  - - org.mapstruct.ap.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.writer.Writable
  Writable.Context

Constructor Summary

Constructors
Constructor and Description
`Type(Types typeUtils, Elements elementUtils, TypeFactory typeFactory, TypeMirror typeMirror, TypeElement typeElement, List<Type> typeParameters, Type implementationType, Type componentType, String packageName, String name, String qualifiedName, boolean isInterface, boolean isEnumType, boolean isIterableType, boolean isCollectionType, boolean isMapType, boolean isImported)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canAccess(Type type, ExecutableElement method)` Whether this type can access the given method declared on the given type.
`int`	`compareTo(Type o)`
`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()` Returns this type's enum constants in case it is an enum, an empty list otherwise.
`String`	`getFullyQualifiedName()`
`Type`	`getImplementationType()` Returns the implementation type to be instantiated in case this type is an interface iterable, collection or map type.
`String`	`getImportName()` The name of this type as to be used within import statements.
`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()` A valid Java expression most suitable for representing null - useful for dealing with primitives from FTL.
`String`	`getPackageName()`
`Map<String,ExecutableElement>`	`getPropertyReadAccessors()` getPropertyReadAccessors
`Map<String,ExecutableElement>`	`getPropertyWriteAccessors(org.mapstruct.ap.prism.CollectionMappingStrategyPrism cmStrategy)` getPropertyWriteAccessors returns a map of the write accessors according to the CollectionMappingStrategy.
`TypeElement`	`getTypeElement()`
`TypeMirror`	`getTypeMirror()`
`List<Type>`	`getTypeParameters()`
`int`	`hashCode()`
`boolean`	`isAnnotatedWith(String annotationTypeName)`
`boolean`	`isArrayType()`
`boolean`	`isAssignableTo(Type other)` Whether this type is assignable to the given other type.
`boolean`	`isCollectionOrMapType()`
`boolean`	`isCollectionType()`
`boolean`	`isEnumType()`
`boolean`	`isImported()` Whether this type is imported by means of an import statement in the currently generated source file (meaning it can be referenced in the generated source using its simple name) or not (meaning it has to be referenced using the fully-qualified name).
`boolean`	`isInterface()`
`boolean`	`isIterableType()` Whether this type is a sub-type of `Iterable` or an array type.
`boolean`	`isMapType()`
`boolean`	`isPrimitive()`
`boolean`	`isVoid()`
`String`	`toString()`

Methods inherited from class org.mapstruct.ap.model.common.ModelElement
write

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

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,
            TypeMirror typeMirror,
            TypeElement typeElement,
            List<Type> typeParameters,
            Type implementationType,
            Type componentType,
            String packageName,
            String name,
            String qualifiedName,
            boolean isInterface,
            boolean isEnumType,
            boolean isIterableType,
            boolean isCollectionType,
            boolean isMapType,
            boolean isImported)
```
- Method Detail
  - getTypeMirror
```
public TypeMirror getTypeMirror()
```
  - getTypeElement
```
public TypeElement getTypeElement()
```
  - getPackageName
```
public String getPackageName()
```
  - getName
```
public String getName()
```
  - 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()
```
  - 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.
  - 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.
  - isCollectionType
```
public boolean isCollectionType()
```
  - isMapType
```
public boolean isMapType()
```
  - isCollectionOrMapType
```
public boolean isCollectionOrMapType()
```
  - isArrayType
```
public boolean isArrayType()
```
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
  - getImportName
```
public String getImportName()
```
    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.
  - isImported
```
public boolean isImported()
```
    Whether this type is imported by means of an import statement in the currently generated source file (meaning it can be referenced in the generated source using its simple name) or not (meaning it has to be referenced using the fully-qualified name).
    
    Returns:
    
    true if the type is imported, false otherwise.
  - isAnnotatedWith
```
public boolean isAnnotatedWith(String annotationTypeName)
```
    Parameters:
    
    annotationTypeName - the fully qualified name of the annotation type
    
    Returns:
    
    true, if the type is annotated with an annotation of the specified type (super-types are not inspected)
  - erasure
```
public Type erasure()
```
  - 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.
  - getPropertyReadAccessors
```
public Map<String,ExecutableElement> getPropertyReadAccessors()
```
    getPropertyReadAccessors
    
    Returns:
    
    an unmodifiable map of all read accessors (including 'is' for booleans), indexed by property name
  - getPropertyWriteAccessors
```
public Map<String,ExecutableElement> getPropertyWriteAccessors(org.mapstruct.ap.prism.CollectionMappingStrategyPrism cmStrategy)
```
    getPropertyWriteAccessors returns a map of the write accessors according to the CollectionMappingStrategy. These accessors include:
    - setters, the obvious candidate :-), getSetters()
    - getters, 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 -
    
    Returns:
    
    an unmodifiable map of all write accessors indexed by property name
  - 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)
```
    Whether this type can access the given method declared on the given type.
  - getNull
```
public String getNull()
```
    A valid Java expression most suitable for representing null - useful for dealing with primitives from FTL.
  - 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

Class Type

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.mapstruct.ap.model.common.ModelElement

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

Methods inherited from class java.lang.Object

Constructor Detail

Type

Method Detail

getTypeMirror

getTypeElement

getPackageName

getName

getTypeParameters

getComponentType

isPrimitive

isInterface

isEnumType

isVoid

getEnumConstants

getImplementationType

isIterableType

isCollectionType

isMapType

isCollectionOrMapType

isArrayType

getFullyQualifiedName

getImportName

getImportTypes

isImported

isAnnotatedWith

erasure

isAssignableTo

getPropertyReadAccessors

getPropertyWriteAccessors

distanceTo

canAccess

getNull

hashCode

equals

compareTo

toString