org.springframework.data.mongodb.core.mapping

Annotation Type Unwrapped

@Documented
 @Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,FIELD,METHOD})
public @interface Unwrapped

The annotation to configure a value object as flattened out in the target document.
Depending on the value of onEmpty() the property is set to null or an empty instance in the case all unwrapped values are null when reading from the result set.

Since:

3.2

Author:

Christoph Strobl

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Unwrapped.OnEmpty	onEmpty Set the load strategy for the unwrapped object if all contained fields yield null values.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	prefix

Element Detail

onEmpty

public abstract Unwrapped.OnEmpty onEmpty

Set the load strategy for the unwrapped object if all contained fields yield null values.
@Unwrapped.Nullable and @Unwrapped.Empty offer shortcuts for this.

Returns:

never null.

prefix

public abstract String prefix

Returns:

prefix for columns in the unwrapped value object. An empty String by default.

Default:

""