org.mapstruct

Enum NullValuePropertyMappingStrategy

java.lang.Object

java.lang.Enum<NullValuePropertyMappingStrategy>

org.mapstruct.NullValuePropertyMappingStrategy

All Implemented Interfaces:

Serializable, Comparable<NullValuePropertyMappingStrategy>

public enum NullValuePropertyMappingStrategy
extends Enum<NullValuePropertyMappingStrategy>

Strategy for dealing with null or not present properties in the source bean. The NullValuePropertyMappingStrategy can be defined on MapperConfig, Mapper, BeanMapping and Mapping. Precedence is arranged in the reverse order. So Mapping will override BeanMapping, will overide Mapper The enum only applies to update methods: methods that update a pre-existing target (annotated with @MappingTarget).

Note: some types of mappings (collections, maps), in which MapStruct is instructed to use a getter or adder as target accessor see CollectionMappingStrategy, MapStruct will always generate a source property null check, regardless the value of the NullValuePropertyMappingStrategy to avoid addition of null to the target collection or map. Since the target is assumed to be initialised this strategy will not be applied.

Since:

1.3

Author:

Sjaak Derksen

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE If a source bean property equals null the target bean property will be ignored and retain its existing value.
SET_TO_DEFAULT If a source bean property equals null the target bean property will be set to its default value.
SET_TO_NULL If a source bean property equals null the target bean property will be set explicitly to null.

Method Summary

Modifier and Type	Method and Description
static NullValuePropertyMappingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NullValuePropertyMappingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SET_TO_NULL

public static final NullValuePropertyMappingStrategy SET_TO_NULL

If a source bean property equals null the target bean property will be set explicitly to null.

SET_TO_DEFAULT

public static final NullValuePropertyMappingStrategy SET_TO_DEFAULT

If a source bean property equals null the target bean property will be set to its default value.

This means:

1. For List MapStruct generates an ArrayList
2. For Map a HashMap
3. For arrays an empty array
4. For String ""
5. for primitive / boxed types a representation of 0 or false
6. For all other objects an new instance is created, requiring an empty constructor.

Make sure that a Mapping.defaultValue() is defined if no empty constructor is available on the default value.

IGNORE

public static final NullValuePropertyMappingStrategy IGNORE

If a source bean property equals null the target bean property will be ignored and retain its existing value.

Method Detail

values

public static NullValuePropertyMappingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NullValuePropertyMappingStrategy c : NullValuePropertyMappingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NullValuePropertyMappingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null