org.mapstruct.ap.model

Class Type

java.lang.Object

org.mapstruct.ap.model.AbstractModelElement

org.mapstruct.ap.model.Type

All Implemented Interfaces:

Comparable<Type>, ModelElement

public class Type
extends AbstractModelElement
implements Comparable<Type>

Represents the type of a bean property, parameter etc. 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.model.ModelElement

ModelElement.Context

Constructor Summary

Constructors

Constructor and Description
Type(TypeMirror typeMirror, List<Type> typeParameters, Type implementationType, boolean isIterableType, boolean isCollectionType, boolean isMapType, Types typeUtils, Elements elementUtils)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Type o)
boolean	equals(Object obj)
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	isAssignableTo(Type other) Whether this type is assignable to the given other type.
boolean	isCollectionType()
boolean	isEnumType()
boolean	isInterface()
boolean	isIterableType()
boolean	isMapType()
boolean	isPrimitive()
String	toString()

Methods inherited from class org.mapstruct.ap.model.AbstractModelElement

write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Type

public Type(TypeMirror typeMirror,
    List<Type> typeParameters,
    Type implementationType,
    boolean isIterableType,
    boolean isCollectionType,
    boolean isMapType,
    Types typeUtils,
    Elements elementUtils)

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

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 interface: 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 interface ModelElement

Returns:

A set with type referenced by this model element. Must not be null.

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.

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