Class UnwindOperation.UnwindOperationBuilder
java.lang.Object
org.springframework.data.mongodb.core.aggregation.UnwindOperation.UnwindOperationBuilder
- All Implemented Interfaces:
UnwindOperation.EmptyArraysBuilder
,UnwindOperation.IndexBuilder
,UnwindOperation.PathBuilder
- Enclosing class:
- UnwindOperation
public static final class UnwindOperation.UnwindOperationBuilder
extends Object
implements UnwindOperation.PathBuilder, UnwindOperation.IndexBuilder, UnwindOperation.EmptyArraysBuilder
Builder for fluent
UnwindOperation
creation.- Since:
- 1.10
- Author:
- Mark Paluch
-
Method Summary
Modifier and TypeMethodDescriptionarrayIndex
(String field) Exposes the array index asfield
.static UnwindOperation.PathBuilder
Creates new builder forUnwindOperation
.Do not expose the array index.Output documents if the array is null or empty.Do not output documents if the array is null or empty.
-
Method Details
-
newBuilder
Creates new builder forUnwindOperation
.- Returns:
- never null.
-
preserveNullAndEmptyArrays
Description copied from interface:UnwindOperation.EmptyArraysBuilder
Output documents if the array is null or empty.- Specified by:
preserveNullAndEmptyArrays
in interfaceUnwindOperation.EmptyArraysBuilder
- Returns:
-
skipNullAndEmptyArrays
Description copied from interface:UnwindOperation.EmptyArraysBuilder
Do not output documents if the array is null or empty.- Specified by:
skipNullAndEmptyArrays
in interfaceUnwindOperation.EmptyArraysBuilder
- Returns:
-
arrayIndex
Description copied from interface:UnwindOperation.IndexBuilder
Exposes the array index asfield
.- Specified by:
arrayIndex
in interfaceUnwindOperation.IndexBuilder
- Parameters:
field
- field name to expose the field array index, must not be null or empty.- Returns:
-
noArrayIndex
Description copied from interface:UnwindOperation.IndexBuilder
Do not expose the array index.- Specified by:
noArrayIndex
in interfaceUnwindOperation.IndexBuilder
- Returns:
-
path
- Specified by:
path
in interfaceUnwindOperation.PathBuilder
- Parameters:
path
- the path to unwind, must not be null or empty.- Returns:
-