org.mapstruct

Annotation Type MapMapping

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

Configures the mapping between two map types, e.g. Map<String, String> and Map<Long, Date>.

Note: at least one element needs to be specified

Author:

Gunnar Morling

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	keyDateFormat A format string as processable by SimpleDateFormat if the annotated method maps from a map with key type String to an map with key type Date or vice-versa.
Class<? extends Annotation>[]	keyQualifiedBy A key value qualifier can be specified to aid the selection process of a suitable mapper.
Class<?>	keyTargetType Specifies the type of the key to be used in the result of the mapping method in case multiple mapping methods qualify.
NullValueMappingStrategy	nullValueMappingStrategy The strategy to be applied when null is passed as source value to this map mapping.
String	valueDateFormat A format string as processable by SimpleDateFormat if the annotated method maps from a map with value type String to an map with value type Date or vice-versa.
Class<? extends Annotation>[]	valueQualifiedBy A value qualifier can be specified to aid the selection process of a suitable mapper for the values in the map.
Class<?>	valueTargetType Specifies the type of the value to be used in the result of the mapping method in case multiple mapping methods qualify.

Element Detail

keyDateFormat

public abstract String keyDateFormat

A format string as processable by SimpleDateFormat if the annotated method maps from a map with key type String to an map with key type Date or vice-versa. Will be ignored for all other key types.

Returns:

A date format string as processable by SimpleDateFormat.

Default:

""

valueDateFormat

public abstract String valueDateFormat

A format string as processable by SimpleDateFormat if the annotated method maps from a map with value type String to an map with value type Date or vice-versa. Will be ignored for all other value types.

Returns:

A date format string as processable by SimpleDateFormat.

Default:

""

keyQualifiedBy

public abstract Class<? extends Annotation>[] keyQualifiedBy

A key value qualifier can be specified to aid the selection process of a suitable mapper. This is useful in case multiple mappers (hand written of internal) qualify and result in an 'Ambiguous mapping methods found' 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:

{}

valueQualifiedBy

public abstract Class<? extends Annotation>[] valueQualifiedBy

A value qualifier can be specified to aid the selection process of a suitable mapper for the values in the map. This is useful in case multiple mappers (hand written of internal) qualify and result in an 'Ambiguous mapping methods found' 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:

{}

keyTargetType

public abstract Class<?> keyTargetType

Specifies the type of the key to be used in the result of the mapping method in case multiple mapping methods qualify.

Returns:

the resultType to select

Default:

void.class

valueTargetType

public abstract Class<?> valueTargetType

Specifies the type of the value to be used in the result of the mapping method in case multiple mapping methods qualify.

Returns:

the resultType to select

Default:

void.class

nullValueMappingStrategy

public abstract NullValueMappingStrategy nullValueMappingStrategy

The strategy to be applied when null is passed as source value to this map 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