org.mapstruct

Annotation Type MapperConfig

@Target(value=TYPE)
 @Retention(value=CLASS)
public @interface MapperConfig

Marks a class or interface as configuration source for generated mappers. This allows to share common configurations between several mapper classes.

Generally, any settings given via Mapper take precedence over the settings given via the referenced MapperConfig. The lists of referenced mappers given via Mapper.uses() and uses() will be merged.

Additionally, mapper configuration classes may declare one more prototype mapping methods. These methods are not meant to be invoked themselves (no implementation will generated for mapper config classes), but serve as configuration template for mapping methods declared by actual mapper classes. Depending on the configured mappingInheritanceStrategy(), the configuration can be inherited either explicitly using InheritConfiguration or InheritInverseConfiguration, or automatically in case all source and target types are assignable.

Author:

Sjaak Derksen

See Also:

Mapper.config()

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CollectionMappingStrategy	collectionMappingStrategy The strategy to be applied when propagating the value of collection-typed properties.
String	componentModel Specifies the component model to which the generated mapper should adhere.
String	implementationName Specifies the name of the implementation class.
String	implementationPackage Specifies the target package for the generated implementation.
MappingInheritanceStrategy	mappingInheritanceStrategy The strategy to use for applying method-level configuration annotations of prototype methods in the interface annotated with this annotation.
NullValueCheckStrategy	nullValueCheckStrategy Determines when to include a null check on the source property value of a bean mapping.
NullValueMappingStrategy	nullValueMappingStrategy The strategy to be applied when null is passed as source value to mapping methods.
ReportingPolicy	unmappedTargetPolicy How unmapped properties of the target type of a mapping should be reported.
Class<?>[]	uses The mapper types used by this mapper.

Element Detail

uses

public abstract Class<?>[] uses

The mapper types used by this mapper.

Returns:

The mapper types used by this mapper.

Default:

{}

unmappedTargetPolicy

public abstract ReportingPolicy unmappedTargetPolicy

How unmapped properties of the target type of a mapping should be reported.

Returns:

The reporting policy for unmapped target properties.

Default:

org.mapstruct.ReportingPolicy.WARN

componentModel

public abstract String componentModel

Specifies the component model to which the generated mapper should adhere. Supported values are

• default: the mapper uses no component model, instances are typically retrieved via Mappers.getMapper(Class)
• cdi: the generated mapper is an application-scoped CDI bean and can be retrieved via @Inject
• spring: the generated mapper is a Spring bean and can be retrieved via @Autowired
• jsr330: the generated mapper is annotated with @javax.inject.Named and @Singleton, and can be retrieved via @Inject

Returns:

The component model for the generated mapper.

Default:

"default"

implementationName

public abstract String implementationName

Specifies the name of the implementation class. The <CLASS_NAME> will be replaced by the interface/abstract class name.

Defaults to postfixing the name with Impl: <CLASS_NAME>Impl

Returns:

The implementation name.

See Also:

implementationPackage()

Default:

"<CLASS_NAME>Impl"

implementationPackage

public abstract String implementationPackage

Specifies the target package for the generated implementation. The <PACKAGE_NAME> will be replaced by the interface's or abstract class' package.

Defaults to using the same package as the mapper interface/abstract class

Returns:

the implementation package.

See Also:

implementationName()

Default:

"<PACKAGE_NAME>"

collectionMappingStrategy

public abstract CollectionMappingStrategy collectionMappingStrategy

The strategy to be applied when propagating the value of collection-typed properties. By default, only JavaBeans accessor methods (setters or getters) will be used, but it is also possible to invoke a corresponding adder method for each element of the source collection (e.g. orderDto.addOrderLine()).

Returns:

The strategy applied when propagating the value of collection-typed properties.

Default:

org.mapstruct.CollectionMappingStrategy.ACCESSOR_ONLY

nullValueMappingStrategy

public abstract NullValueMappingStrategy nullValueMappingStrategy

The strategy to be applied when null is passed as source value to mapping methods. If no strategy is configured, NullValueMappingStrategy.RETURN_NULL will be used by default.

Returns:

The strategy to be applied when null is passed as source value to mapping methods.

Default:

org.mapstruct.NullValueMappingStrategy.RETURN_NULL

mappingInheritanceStrategy

public abstract MappingInheritanceStrategy mappingInheritanceStrategy

The strategy to use for applying method-level configuration annotations of prototype methods in the interface annotated with this annotation. Annotations that can be inherited are for example Mapping, IterableMapping, MapMapping, or BeanMapping.

If no strategy is configured, MappingInheritanceStrategy.EXPLICIT will be used as default.

Returns:

The strategy to use for applying @Mapping configurations of prototype methods in the interface annotated with this annotation.

Default:

org.mapstruct.MappingInheritanceStrategy.EXPLICIT

nullValueCheckStrategy

public abstract NullValueCheckStrategy nullValueCheckStrategy

Determines when to include a null check on the source property value of a bean mapping. Can be overridden by the one on Mapper or Mapping.

Returns:

strategy how to do null checking

Default:

org.mapstruct.NullValueCheckStrategy.ON_IMPLICIT_CONVERSION