Package org.mapstruct.ap.spi

Class ImmutablesBuilderProvider

java.lang.Object

org.mapstruct.ap.spi.DefaultBuilderProvider

org.mapstruct.ap.spi.ImmutablesBuilderProvider

All Implemented Interfaces:

BuilderProvider

@Experimental("The Immutables builder provider might change in a subsequent release")
public class ImmutablesBuilderProvider
extends DefaultBuilderProvider

Builder provider for Immutables. A custom provider is needed because Immutables creates an implementation of an interface and that implementation has the builder. This implementation would try to find the type created by Immutables and would look for the builder in it. Only types annotated with the org.immutables.value.Value.Immutable are considered for this discovery.

Author:

Filip Hrisafov

Field Summary

Fields inherited from class org.mapstruct.ap.spi.DefaultBuilderProvider

elementUtils, typeUtils

Constructor Summary

Constructors

Constructor	Description
ImmutablesBuilderProvider()

Method Summary

Modifier and Type	Method	Description
protected TypeElement	asImmutableElement(TypeElement typeElement)
protected BuilderInfo	findBuilderInfo(TypeElement typeElement)	Find the BuilderInfo for the given typeElement.
protected BuilderInfo	findBuilderInfoForImmutables(TypeElement typeElement)
protected BuilderInfo	findBuilderInfoForImmutables(TypeElement typeElement, TypeElement immutableAnnotation)

Methods inherited from class org.mapstruct.ap.spi.DefaultBuilderProvider

findBuilderInfo, findBuilderInfo, findBuildMethods, getTypeElement, init, isBuildMethod, isBuildMethod, isPossibleBuilderCreationMethod, shouldIgnore

Methods inherited from class java.lang.Object

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

Constructor Details

ImmutablesBuilderProvider

public ImmutablesBuilderProvider()

Method Details

findBuilderInfo

protected BuilderInfo findBuilderInfo(TypeElement typeElement)

Description copied from class: DefaultBuilderProvider

Find the BuilderInfo for the given typeElement.

The default implementation iterates over all the methods in typeElement and uses DefaultBuilderProvider.isPossibleBuilderCreationMethod(ExecutableElement, TypeElement) and DefaultBuilderProvider.findBuildMethods(TypeElement, TypeElement) to create the BuilderInfo.

The default implementation uses DefaultBuilderProvider.shouldIgnore(TypeElement) to check if the typeElement should be ignored.

In case there are multiple BuilderInfo then a MoreThanOneBuilderCreationMethodException is thrown.

Overrides:

findBuilderInfo in class DefaultBuilderProvider

Parameters:

typeElement - the type element for which a builder searched

Returns:

the BuilderInfo or null if no builder was found for the type DefaultBuilderProvider.findBuildMethods(TypeElement, TypeElement)

findBuilderInfoForImmutables

protected BuilderInfo findBuilderInfoForImmutables(TypeElement typeElement)

findBuilderInfoForImmutables

protected BuilderInfo findBuilderInfoForImmutables(TypeElement typeElement,
 TypeElement immutableAnnotation)

asImmutableElement

protected TypeElement asImmutableElement(TypeElement typeElement)