org.mapstruct

Annotation Type ValueMapping

@Repeatable(value=ValueMappings.class)
 @Retention(value=CLASS)
 @Target(value=METHOD)
public @interface ValueMapping

Configures the mapping of source constant value to target constant value.

Supported mappings are

1. Enumeration to Enumeration

Example 1:

 
 public enum OrderType { RETAIL, B2B, EXTRA, STANDARD, NORMAL }

 public enum ExternalOrderType { RETAIL, B2B, SPECIAL, DEFAULT }

 @ValueMapping(source = "EXTRA", target = "SPECIAL"),
 @ValueMapping(source = "STANDARD", target = "DEFAULT"),
 @ValueMapping(source = "NORMAL", target = "DEFAULT")
 ExternalOrderType orderTypeToExternalOrderType(OrderType orderType);
 
 Mapping result:
 +---------------------+----------------------------+
 | OrderType           | ExternalOrderType          |
 +---------------------+----------------------------+
 | null                | null                       |
 | OrderType.EXTRA     | ExternalOrderType.SPECIAL  |
 | OrderType.STANDARD  | ExternalOrderType.DEFAULT  |
 | OrderType.NORMAL    | ExternalOrderType.DEFAULT  |
 | OrderType.RETAIL    | ExternalOrderType.RETAIL   |
 | OrderType.B2B       | ExternalOrderType.B2B      |
 +---------------------+----------------------------+
 

MapStruct will WARN on incomplete mappings. However, if for some reason no match is found an IllegalStateException will be thrown.

Example 2:

 
 @ValueMapping( source = MappingConstants.NULL, target = "DEFAULT" ),
 @ValueMapping( source = "STANDARD", target = MappingConstants.NULL ),
 @ValueMapping( source = MappingConstants.ANY_REMAINING, target = "SPECIAL" )
 ExternalOrderType orderTypeToExternalOrderType(OrderType orderType);
 
 Mapping result:
 +---------------------+----------------------------+
 | OrderType           | ExternalOrderType          |
 +---------------------+----------------------------+
 | null                | ExternalOrderType.DEFAULT  |
 | OrderType.STANDARD  | null                       |
 | OrderType.RETAIL    | ExternalOrderType.RETAIL   |
 | OrderType.B2B       | ExternalOrderType.B2B      |
 | OrderType.NORMAL    | ExternalOrderType.SPECIAL  |
 | OrderType.EXTRA     | ExternalOrderType.SPECIAL  |
 +---------------------+----------------------------+
 

Author:

Sjaak Derksen

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	source The source value constant to use for this mapping.
String	target The target value constant to use for this mapping.

Element Detail

source

public abstract String source

The source value constant to use for this mapping.

Valid values:

1. enum constant name
2. MappingConstants.NULL
3. MappingConstants.ANY_REMAINING
4. MappingConstants.ANY_UNMAPPED

NOTE:When using <ANY_REMAINING>, MapStruct will perform the normal name based mapping, in which source is mapped to target based on enum identifier equality. Using <ANY_UNMAPPED> will not apply name based mapping.

Returns:

The source value.

target

public abstract String target

The target value constant to use for this mapping.

Valid values:

1. enum constant name
2. MappingConstants.NULL

Returns:

The target value.