org.mapstruct.ap

Class MappingProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.mapstruct.ap.MappingProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes(value="org.mapstruct.Mapper")
 @SupportedOptions(value={"mapstruct.suppressGeneratorTimestamp","mapstruct.suppressGeneratorVersionInfoComment","mapstruct.unmappedTargetPolicy","mapstruct.defaultComponentModel"})
public class MappingProcessor
extends AbstractProcessor

A JSR 269 annotation Processor which generates the implementations for mapper interfaces (interfaces annotated with @Mapper).

Implementation notes:

The generation happens by incrementally building up a model representation of each mapper to be generated (a Mapper object), which is then written into the resulting Java source file.

The model instantiation and processing happens in several phases/passes by applying a sequence of ModelElementProcessors. The processors to apply are retrieved using the Java service loader mechanism and are processed in order of their priority. The general processing flow is this:

• retrieve mapping methods
• create the Mapper model
• perform enrichments and modifications (e.g. add annotations for dependency injection)
• if no error occurred, write out the model into Java source files

For reading annotation attributes, prisms as generated with help of the Hickory tool are used. These prisms allow a comfortable access to annotations and their attributes without depending on their class objects.

The creation of Java source files is done using the FreeMarker template engine. Each node of the mapper model has a corresponding FreeMarker template file which provides the Java representation of that element and can include sub-elements via a custom FreeMarker directive. That way writing out a root node of the model (Mapper) will recursively include all contained sub-elements (such as its methods, their property mappings etc.).

Author:

Gunnar Morling

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALWAYS_GENERATE_SERVICE_FILE
protected static String	DEFAULT_COMPONENT_MODEL
protected static String	SUPPRESS_GENERATOR_TIMESTAMP
protected static String	SUPPRESS_GENERATOR_VERSION_INFO_COMMENT
protected static String	UNMAPPED_TARGET_POLICY

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
MappingProcessor()

Method Summary

Modifier and Type	Method and Description
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUPPRESS_GENERATOR_TIMESTAMP

protected static final String SUPPRESS_GENERATOR_TIMESTAMP

See Also:

Constant Field Values

SUPPRESS_GENERATOR_VERSION_INFO_COMMENT

protected static final String SUPPRESS_GENERATOR_VERSION_INFO_COMMENT

See Also:

Constant Field Values

UNMAPPED_TARGET_POLICY

protected static final String UNMAPPED_TARGET_POLICY

See Also:

Constant Field Values

DEFAULT_COMPONENT_MODEL

protected static final String DEFAULT_COMPONENT_MODEL

See Also:

Constant Field Values

ALWAYS_GENERATE_SERVICE_FILE

protected static final String ALWAYS_GENERATE_SERVICE_FILE

See Also:

Constant Field Values

Constructor Detail

MappingProcessor

public MappingProcessor()

Method Detail

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnvironment)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor