Class UnsetOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.UnsetOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

public class UnsetOperation
extends Object
implements FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Removes fields from documents.

Since:

3.0

Author:

Christoph Strobl

See Also:

• MongoDB Aggregation Framework: $unset

Nested Class Summary

Nested classes/interfaces inherited from interface FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor	Description
UnsetOperation(Collection<Object> fields)	Create new instance of UnsetOperation.

Method Summary

Modifier and Type	Method	Description
UnsetOperation	and(String... fields)	Also unset the given fields.
UnsetOperation	and(Field... fields)	Also unset the given fields.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.
static UnsetOperation	unset(String... fields)	Create new instance of UnsetOperation.

Methods inherited from class Object

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

Methods inherited from interface AggregationOperation

toPipelineStages

Methods inherited from interface FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

inheritsFields

Constructor Details

UnsetOperation

public UnsetOperation(Collection<Object> fields)

Create new instance of UnsetOperation.

Parameters:

fields - must not be null.

Method Details

unset

public static UnsetOperation unset(String... fields)

Create new instance of UnsetOperation.

Parameters:

fields - must not be null.

Returns:

new instance of UnsetOperation.

and

@Contract("_ -> new")
public UnsetOperation and(String... fields)

Also unset the given fields.

Parameters:

fields - must not be null.

Returns:

new instance of UnsetOperation.

and

@Contract("_ -> new")
public UnsetOperation and(Field... fields)

Also unset the given fields.

Parameters:

fields - must not be null.

Returns:

new instance of UnsetOperation.

getFields

public ExposedFields getFields()

Description copied from interface: FieldsExposingAggregationOperation

Returns the fields exposed by the AggregationOperation.

Specified by:

getFields in interface FieldsExposingAggregationOperation

Returns:

will never be null.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.