Package dev.morphia.aggregation.stages
Class Skip
- java.lang.Object
-
- dev.morphia.aggregation.stages.Stage
-
- dev.morphia.aggregation.stages.Skip
-
public class Skip extends Stage
Randomly selects the specified number of documents from its input.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Skip(long size)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description long
getSize()
static Skip
of(long size)
Deprecated, for removal: This API element is subject to removal in a future version.useskip(long)
static Skip
skip(long size)
Creates a new stage with the given skip size-
Methods inherited from class dev.morphia.aggregation.stages.Stage
aggregation, stageName
-
-
-
-
Method Detail
-
of
@Deprecated(forRemoval=true) public static Skip of(long size)
Deprecated, for removal: This API element is subject to removal in a future version.useskip(long)
Creates a new stage with the given skip size- Parameters:
size
- the skip size- Returns:
- the new stage
-
skip
public static Skip skip(long size)
Creates a new stage with the given skip size- Parameters:
size
- the skip size- Returns:
- the new stage
- Since:
- 2.2
-
getSize
@MorphiaInternal public long getSize()
- Returns:
- the size
Developer note.This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
-
-