org.springframework.data.mongodb.core.aggregation

Class SkipOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SkipOperation

All Implemented Interfaces:

AggregationOperation

public class SkipOperation
extends Object
implements AggregationOperation

Encapsulates the aggregation framework $skip-operation.

We recommend to use the static factory method Aggregation.skip(int) instead of creating instances of this class directly.

Since:

1.3

Author:

Thomas Darimont, Oliver Gierke, Christoph Strobl

See Also:

MongoDB Aggregation Framework: $skip

Constructor Summary

Constructors

Constructor and Description
SkipOperation(long skipCount) Creates a new SkipOperation skipping the given number of elements.

Method Summary

Modifier and Type	Method and Description
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationOperation

toPipelineStages

Constructor Detail

SkipOperation

public SkipOperation(long skipCount)

Creates a new SkipOperation skipping the given number of elements.

Parameters:

skipCount - number of documents to skip, must not be less than zero.

Method Detail

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