org.mapstruct

Annotation Type BeanMapping

@Target(value=METHOD)
 @Retention(value=CLASS)
public @interface BeanMapping

Configures the mapping between two bean types.

Either resultType() , qualifiedBy() or nullValueMappingStrategy() must be specified.

Author:

Sjaak Derksen

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
NullValueMappingStrategy	nullValueMappingStrategy The strategy to be applied when null is passed as source value to this bean mapping.
Class<? extends Annotation>[]	qualifiedBy A qualifier can be specified to aid the selection process of a suitable factory method.
String[]	qualifiedByName See: { @link #qualifiedBy() }.
Class<?>	resultType Specifies the result type of the factory method to be used in case several factory methods qualify.

Element Detail

resultType

public abstract Class<?> resultType

Specifies the result type of the factory method to be used in case several factory methods qualify.

Returns:

the resultType to select

Default:

void.class

qualifiedBy

public abstract Class<? extends Annotation>[] qualifiedBy

A qualifier can be specified to aid the selection process of a suitable factory method. This is useful in case multiple factory method (hand written of internal) qualify and result in an 'Ambiguous factory methods' error. A qualifier is a custom annotation and can be placed on either a hand written mapper class or a method.

Returns:

the qualifiers

Default:

{}

qualifiedByName

public abstract String[] qualifiedByName

See: { @link #qualifiedBy() }. String form of a predefined { @link @Qualifier }. The { @link @Qualifier } is more verbose, but offers more flexibility in terms of for instance refactoring. At the other hand, there is no need to define own annotations.

Returns:

the qualifiers

Default:

{}

nullValueMappingStrategy

public abstract NullValueMappingStrategy nullValueMappingStrategy

The strategy to be applied when null is passed as source value to this bean mapping. If no strategy is configured, the strategy given via MapperConfig.nullValueMappingStrategy() or Mapper.nullValueMappingStrategy() will be applied, using NullValueMappingStrategy.RETURN_NULL by default.

Returns:

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

Default:

org.mapstruct.NullValueMappingStrategy.RETURN_NULL