Package org.mapstruct

Annotation Type MapMapping

@Target(METHOD) @Retention(CLASS) public @interface MapMapping
Configures the mapping between two map types, e.g. Map<String, String> and Map<Long, Date>.

Example: 


 @Mapper
 public interface SimpleMapper {
       @MapMapping(valueDateFormat = "dd.MM.yyyy")
       Map<String, String> longDateMapToStringStringMap(Map<Long, Date> source);
 }
 

 // generates
 public class SimpleMapperImpl implements SimpleMapper {
      @Override
      public Map<String, String> longDateMapToStringStringMap(Map<Long, Date> source) } {
          Map<String, String> map = new HashMap<String, String>(); }
          for ( java.util.Map.Entry<Long, Date> entry : source.entrySet() ) } {
              String key = new DecimalFormat( "" ).format( entry.getKey() );
              String value = new SimpleDateFormat( "dd.MM.yyyy" ).format( entry.getValue() );
              map.put( key, value );
          }
          // ...
      }
 }

NOTE: at least one element needs to be specified

Author:
Gunnar Morling

  • Element Details

    • keyDateFormat

      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.

      If the locale() is specified, the format will consider the specified locale when processing the date. Otherwise, the system's default locale will be used.

      Returns:
      A date format string as processable by SimpleDateFormat.
      See Also:
      Default:
      ""

    • valueDateFormat

      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.

      If the locale() is specified, the format will consider the specified locale when processing the date. Otherwise, the system's default locale will be used.

      Returns:
      A date format string as processable by SimpleDateFormat.
      See Also:
      Default:
      ""

    • keyNumberFormat

      String keyNumberFormat
      A format string as processable by DecimalFormat if the annotated method maps from a Number to a String or vice-versa. Will be ignored for all other key types.

      If the locale() is specified, the number format will be applied in the context of the given locale. Otherwise, the system's default locale will be used.

      Returns:
      A decimal format string as processable by DecimalFormat.
      See Also:
      Default:
      ""

    • valueNumberFormat

      String valueNumberFormat
      A format string as processable by DecimalFormat if the annotated method maps from a Number to a String or vice-versa. Will be ignored for all other value types.

      If the locale() is specified, the number format will be applied in the context of the given locale. Otherwise, the system's default locale will be used.

      Returns:
      A decimal format string as processable by DecimalFormat.
      See Also:
      Default:
      ""

    • locale

      String locale
      Specifies the locale to be used when processing SimpleDateFormat or DecimalFormat for key or value mappings in maps. The locale should be a plain tag representing the language, such as "en" for English, "de" for German, etc.

      If no locale is specified, the system's default locale will be used.

      Returns:
      A string representing the locale to be used when formatting dates or numbers in maps.
      Default:
      ""

    • keyQualifiedBy

      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
      See Also:
      Default:
      {}

    • keyQualifiedByName

      String[] keyQualifiedByName
      String-based form of qualifiers; When looking for a suitable mapping method to map this map mapping method's key type, MapStruct will only consider those methods carrying directly or indirectly (i.e. on the class-level) a Named annotation for each of the specified qualifier names.

      Note that annotation-based qualifiers are generally preferable as they allow more easily to find references and are safe for refactorings, but name-based qualifiers can be a less verbose alternative when requiring a large number of qualifiers as no custom annotation types are needed.

      Returns:
      One or more qualifier name(s)
      See Also:
      Default:
      {}

    • valueQualifiedBy

      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
      See Also:
      Default:
      {}

    • valueQualifiedByName

      String[] valueQualifiedByName
      String-based form of qualifiers; When looking for a suitable mapping method to map this map mapping method's value type, MapStruct will only consider those methods carrying directly or indirectly (i.e. on the class-level) a Named annotation for each of the specified qualifier names.

      Note that annotation-based qualifiers are generally preferable as they allow more easily to find references and are safe for refactorings, but name-based qualifiers can be a less verbose alternative when requiring a large number of qualifiers as no custom annotation types are needed.

      Returns:
      One or more qualifier name(s)
      See Also:
      Default:
      {}

    • keyTargetType

      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

      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

      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:
      RETURN_NULL

    • keyMappingControl

      Class<? extends Annotation> keyMappingControl
      Allows detailed control over the key mapping process.
      Returns:
      the mapping control
      Since:
      1.4
      See Also:
      Default:
      org.mapstruct.control.MappingControl.class

    • valueMappingControl

      Class<? extends Annotation> valueMappingControl
      Allows detailed control over the value mapping process.
      Returns:
      the mapping control
      Since:
      1.4
      See Also:
      Default:
      org.mapstruct.control.MappingControl.class