Package org.springframework.data.mongodb.core

Interface CursorPreparer

All Superinterfaces:

ReadPreferenceAware

public interface CursorPreparer
extends ReadPreferenceAware

Simple callback interface to allow customization of a FindIterable.

Author:

Oliver Gierke, Christoph Strobl

Field Summary

Fields

Modifier and Type	Field	Description
static final CursorPreparer	NO_OP_PREPARER	Default CursorPreparer just passing on the given FindIterable.

Method Summary

Modifier and Type	Method	Description
default ReadPreference	getReadPreference()
default FindIterable<Document>	initiateFind(MongoCollection<Document> collection, Function<MongoCollection<Document>,FindIterable<Document>> find)	Apply query specific settings to MongoCollection and initiate a find operation returning a FindIterable via the given find function.
FindIterable<Document>	prepare(FindIterable<Document> iterable)	Prepare the given cursor (apply limits, skips and so on).

Methods inherited from interface org.springframework.data.mongodb.core.ReadPreferenceAware

hasReadPreference

Field Details

NO_OP_PREPARER

static final CursorPreparer NO_OP_PREPARER

Default CursorPreparer just passing on the given FindIterable.

Since:

2.2

Method Details

prepare

FindIterable<Document> prepare(FindIterable<Document> iterable)

Prepare the given cursor (apply limits, skips and so on). Returns the prepared cursor.

Parameters:

iterable - must not be null.

Returns:

never null.

initiateFind

default FindIterable<Document> initiateFind(MongoCollection<Document> collection,
 Function<MongoCollection<Document>,FindIterable<Document>> find)

Apply query specific settings to MongoCollection and initiate a find operation returning a FindIterable via the given find function.

Parameters:

collection - must not be null.

find - must not be null.

Returns:

never null.

Throws:

IllegalArgumentException - if one of the required arguments is null.

Since:

2.2

getReadPreference

@Nullable
default ReadPreference getReadPreference()

Specified by:

getReadPreference in interface ReadPreferenceAware

Returns:

the ReadPreference to apply or null if none defined.

Since:

2.2