org.springframework.data.mongodb.core.aggregation

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 Type	Method and Description
UnwindOperation.EmptyArraysBuilder	arrayIndex(String field) Exposes the array index as field.
static UnwindOperation.PathBuilder	newBuilder() Creates new builder for UnwindOperation.
UnwindOperation.EmptyArraysBuilder	noArrayIndex() Do not expose the array index.
UnwindOperation.UnwindOperationBuilder	path(String path)
UnwindOperation	preserveNullAndEmptyArrays() Output documents if the array is null or empty.
UnwindOperation	skipNullAndEmptyArrays() Do not output documents if the array is null or empty.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static UnwindOperation.PathBuilder newBuilder()

Creates new builder for UnwindOperation.

Returns:

never null.

preserveNullAndEmptyArrays

public UnwindOperation preserveNullAndEmptyArrays()

Description copied from interface: UnwindOperation.EmptyArraysBuilder

Output documents if the array is null or empty.

Specified by:

preserveNullAndEmptyArrays in interface UnwindOperation.EmptyArraysBuilder

Returns:

skipNullAndEmptyArrays

public UnwindOperation skipNullAndEmptyArrays()

Description copied from interface: UnwindOperation.EmptyArraysBuilder

Do not output documents if the array is null or empty.

Specified by:

skipNullAndEmptyArrays in interface UnwindOperation.EmptyArraysBuilder

Returns:

arrayIndex

public UnwindOperation.EmptyArraysBuilder arrayIndex(String field)

Description copied from interface: UnwindOperation.IndexBuilder

Exposes the array index as field.

Specified by:

arrayIndex in interface UnwindOperation.IndexBuilder

Parameters:

field - field name to expose the field array index, must not be null or empty.

Returns:

noArrayIndex

public UnwindOperation.EmptyArraysBuilder noArrayIndex()

Description copied from interface: UnwindOperation.IndexBuilder

Do not expose the array index.

Specified by:

noArrayIndex in interface UnwindOperation.IndexBuilder

Returns:

path

public UnwindOperation.UnwindOperationBuilder path(String path)

Specified by:

path in interface UnwindOperation.PathBuilder

Parameters:

path - the path to unwind, must not be null or empty.

Returns: