org.mapstruct

Annotation Type DecoratedWith

@Target(value=TYPE)
 @Retention(value=SOURCE)
public @interface DecoratedWith

Specifies a decorator to be applied to a generated mapper, which e.g. can be used to amend mappings performed by generated mapping methods.

A typical decorator implementation will be an abstract class and only implement/override a subset of the methods of the mapper type which it decorates. All methods not implemented or overridden by the decorator will be implemented by the code generator.

If a constructor with a single parameter accepting the type of the decorated mapper is present, a delegate with generated implementations of all the mapper methods will be passed to this constructor. A typical implementation will store the passed delegate in a field of the decorator and make use of it in the decorator methods.

NOTE: The decorator feature is considered experimental and it may change in future releases. Currently decorators are only supported for the default component model, not for the CDI and Spring models.

Author:

Gunnar Morling

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<?>	value The decorator type.

Element Detail

value

public abstract java.lang.Class<?> value

The decorator type. Must extend or implement the mapper type to which it is applied.

The decorator type must either have a default constructor or a constructor with a single parameter accepting the type of the decorated mapper.

Returns:

the decorator type