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:

java.lang.Comparable<Type>, Writable

public class Type
extends ModelElement
implements java.lang.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(javax.lang.model.util.Types typeUtils, javax.lang.model.util.Elements elementUtils, javax.lang.model.type.TypeMirror typeMirror, javax.lang.model.element.TypeElement typeElement, java.util.List<Type> typeParameters, Type implementationType, java.lang.String packageName, java.lang.String name, java.lang.String qualifiedName, boolean isInterface, boolean isEnumType, boolean isIterableType, boolean isCollectionType, boolean isMapType, boolean isImported)

Method Summary

Modifier and Type	Method and Description
boolean	canAccess(Type type, javax.lang.model.element.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(java.lang.Object obj)
Type	erasure()
javax.lang.model.element.ExecutableElement	getAdderForType(Type collectionProperty, java.lang.String pluralPropertyName) Tries to find an addMethod in this type for given collection property in this type.
java.util.List<javax.lang.model.element.ExecutableElement>	getAlternativeTargetAccessors() Alternative accessors could be a getter for a collection.
java.util.List<java.lang.String>	getEnumConstants() Returns this type's enum constants in case it is an enum, an empty list otherwise.
java.lang.String	getFullyQualifiedName()
java.util.List<javax.lang.model.element.ExecutableElement>	getGetters() getGetters
Type	getImplementationType() Returns the implementation type to be instantiated in case this type is an interface iterable, collection or map type.
java.util.Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
java.lang.String	getName()
java.lang.String	getPackageName()
java.util.List<javax.lang.model.element.ExecutableElement>	getSetters() getSetters
javax.lang.model.element.TypeElement	getTypeElement()
javax.lang.model.type.TypeMirror	getTypeMirror()
java.util.List<Type>	getTypeParameters()
int	hashCode()
boolean	isAnnotatedWith(java.lang.String annotationTypeName)
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()
boolean	isMapType()
boolean	isPrimitive()
java.lang.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(javax.lang.model.util.Types typeUtils,
            javax.lang.model.util.Elements elementUtils,
            javax.lang.model.type.TypeMirror typeMirror,
            javax.lang.model.element.TypeElement typeElement,
            java.util.List<Type> typeParameters,
            Type implementationType,
            java.lang.String packageName,
            java.lang.String name,
            java.lang.String qualifiedName,
            boolean isInterface,
            boolean isEnumType,
            boolean isIterableType,
            boolean isCollectionType,
            boolean isMapType,
            boolean isImported)

Method Detail

getTypeMirror

public javax.lang.model.type.TypeMirror getTypeMirror()

getTypeElement

public javax.lang.model.element.TypeElement getTypeElement()

getPackageName

public java.lang.String getPackageName()

getName

public java.lang.String getName()

getTypeParameters

public java.util.List<Type> getTypeParameters()

isPrimitive

public boolean isPrimitive()

isInterface

public boolean isInterface()

isEnumType

public boolean isEnumType()

getEnumConstants

public java.util.List<java.lang.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()

isCollectionOrMapType

public boolean isCollectionOrMapType()

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

getImportTypes

public java.util.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(java.lang.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.

getGetters

public java.util.List<javax.lang.model.element.ExecutableElement> getGetters()

getGetters

Returns:

an unmodifiable list of all getters (including 'is' for booleans).

getAdderForType

public javax.lang.model.element.ExecutableElement getAdderForType(Type collectionProperty,
                                                                  java.lang.String pluralPropertyName)

Tries to find an addMethod in this type for given collection property in this type. Matching occurs on:

1. The generic type parameter type of the collection should match the adder method argument
2. When there are more candidates, property name is made singular (as good as is possible). This routine looks for a matching add method name.
3. The singularization rules of Dali are used to make a property name singular. This routine looks for a matching add method name.

Parameters:

collectionProperty - property type (assumed collection) to find the adder method for

pluralPropertyName - the property name (assumed plural)

Returns:

corresponding adder method for getter when present

getSetters

public java.util.List<javax.lang.model.element.ExecutableElement> getSetters()

getSetters

Returns:

an unmodifiable list of all setters

getAlternativeTargetAccessors

public java.util.List<javax.lang.model.element.ExecutableElement> getAlternativeTargetAccessors()

Alternative accessors could be a getter for a collection. By means of the Collection.addAll(java.util.Collection) this getter can still be used as targetAccessor. JAXB XJC tool generates such constructs. This method can be extended when new cases come along.

Returns:

an unmodifiable list of alternative target accessors.

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,
                         javax.lang.model.element.ExecutableElement method)

Whether this type can access the given method declared on the given type.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Type o)

Specified by:

compareTo in interface java.lang.Comparable<Type>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object