org.mapstruct.ap.model.common

Class Type

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, TypeMirror typeMirror, TypeElement typeElement, List<Type> typeParameters, Type implementationType, String packageName, String name, String qualifiedName, boolean isInterface, boolean isEnumType, boolean isIterableType, boolean isCollectionType, boolean isMapType, boolean isImported)

Method Summary

Methods

Modifier and Type	Method and Description
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()
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.
Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
String	getName()
String	getPackageName()
TypeElement	getTypeElement()
TypeMirror	getTypeMirror()
List<Type>	getTypeParameters()
int	hashCode()
boolean	isAnnotatedWith(String annotationTypeName)
boolean	isAssignableTo(Type other) Whether this type is assignable to the given other type.
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()
boolean	isMapType()
boolean	isPrimitive()
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,
    TypeMirror typeMirror,
    TypeElement typeElement,
    List<Type> typeParameters,
    Type implementationType,
    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()

isPrimitive

public boolean isPrimitive()

isInterface

public boolean isInterface()

isEnumType

public boolean isEnumType()

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()

isCollectionType

public boolean isCollectionType()

isMapType

public boolean isMapType()

getFullyQualifiedName

public String getFullyQualifiedName()

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.

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

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