Package io.micronaut.data.mongodb.operations.options

Class MongoFindOptions

java.lang.Object

io.micronaut.data.mongodb.operations.options.MongoFindOptions

public final class MongoFindOptions
extends java.lang.Object

The MongoDB's find options.

Since:

3.3.0

Author:

Denis Stepanov

Constructor Summary

Constructors

Constructor	Description
MongoFindOptions()
MongoFindOptions(MongoFindOptions options)

Method Summary

Modifier and Type	Method	Description
MongoFindOptions	allowDiskUse(java.lang.Boolean allowDiskUse)
MongoFindOptions	batchSize(java.lang.Integer batchSize)
MongoFindOptions	collation(com.mongodb.client.model.Collation collation)
MongoFindOptions	comment(java.lang.String comment)
void	copyNotNullFrom(MongoFindOptions options)
MongoFindOptions	cursorType(com.mongodb.CursorType cursorType)
MongoFindOptions	filter(org.bson.conversions.Bson filter)
java.lang.Boolean	getAllowDiskUse()
java.lang.Integer	getBatchSize()
com.mongodb.client.model.Collation	getCollation()
java.lang.String	getComment()
com.mongodb.CursorType	getCursorType()
org.bson.conversions.Bson	getFilter()
org.bson.conversions.Bson	getHint()
java.lang.Integer	getLimit()
org.bson.conversions.Bson	getMax()
java.lang.Long	getMaxAwaitTimeMS()
java.lang.Long	getMaxTimeMS()
org.bson.conversions.Bson	getMin()
java.lang.Boolean	getNoCursorTimeout()
java.lang.Boolean	getPartial()
org.bson.conversions.Bson	getProjection()
java.lang.Boolean	getReturnKey()
java.lang.Boolean	getShowRecordId()
java.lang.Integer	getSkip()
org.bson.conversions.Bson	getSort()
MongoFindOptions	hint(org.bson.conversions.Bson hint)
boolean	isEmpty()
MongoFindOptions	limit(java.lang.Integer limit)
MongoFindOptions	max(org.bson.conversions.Bson max)
MongoFindOptions	maxAwaitTimeMS(java.lang.Long maxAwaitTimeMS)
MongoFindOptions	maxTimeMS(java.lang.Long maxTimeMS)
MongoFindOptions	min(org.bson.conversions.Bson min)
MongoFindOptions	noCursorTimeout(java.lang.Boolean noCursorTimeout)
MongoFindOptions	partial(java.lang.Boolean partial)
MongoFindOptions	projection(org.bson.conversions.Bson projection)
MongoFindOptions	returnKey(java.lang.Boolean returnKey)
MongoFindOptions	showRecordId(java.lang.Boolean showRecordId)
MongoFindOptions	skip(java.lang.Integer skip)
MongoFindOptions	sort(org.bson.conversions.Bson sort)

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoFindOptions

public MongoFindOptions()

MongoFindOptions

public MongoFindOptions(MongoFindOptions options)

Method Detail

copyNotNullFrom

public void copyNotNullFrom(MongoFindOptions options)

isEmpty

public boolean isEmpty()

getFilter

@Nullable
public org.bson.conversions.Bson getFilter()

filter

public MongoFindOptions filter(org.bson.conversions.Bson filter)

getBatchSize

@Nullable
public java.lang.Integer getBatchSize()

batchSize

public MongoFindOptions batchSize(java.lang.Integer batchSize)

getLimit

@Nullable
public java.lang.Integer getLimit()

limit

public MongoFindOptions limit(java.lang.Integer limit)

getProjection

@Nullable
public org.bson.conversions.Bson getProjection()

projection

public MongoFindOptions projection(org.bson.conversions.Bson projection)

getMaxTimeMS

@Nullable
public java.lang.Long getMaxTimeMS()

maxTimeMS

public MongoFindOptions maxTimeMS(java.lang.Long maxTimeMS)

getMaxAwaitTimeMS

@Nullable
public java.lang.Long getMaxAwaitTimeMS()

maxAwaitTimeMS

public MongoFindOptions maxAwaitTimeMS(java.lang.Long maxAwaitTimeMS)

getSkip

@Nullable
public java.lang.Integer getSkip()

skip

public MongoFindOptions skip(java.lang.Integer skip)

getSort

@Nullable
public org.bson.conversions.Bson getSort()

sort

public MongoFindOptions sort(org.bson.conversions.Bson sort)

getCursorType

@Nullable
public com.mongodb.CursorType getCursorType()

cursorType

public MongoFindOptions cursorType(com.mongodb.CursorType cursorType)

getNoCursorTimeout

@Nullable
public java.lang.Boolean getNoCursorTimeout()

noCursorTimeout

public MongoFindOptions noCursorTimeout(java.lang.Boolean noCursorTimeout)

getPartial

@Nullable
public java.lang.Boolean getPartial()

partial

public MongoFindOptions partial(java.lang.Boolean partial)

getCollation

@Nullable
public com.mongodb.client.model.Collation getCollation()

collation

public MongoFindOptions collation(com.mongodb.client.model.Collation collation)

getComment

@Nullable
public java.lang.String getComment()

comment

public MongoFindOptions comment(java.lang.String comment)

getHint

@Nullable
public org.bson.conversions.Bson getHint()

hint

public MongoFindOptions hint(org.bson.conversions.Bson hint)

getMax

@Nullable
public org.bson.conversions.Bson getMax()

max

public MongoFindOptions max(org.bson.conversions.Bson max)

getMin

@Nullable
public org.bson.conversions.Bson getMin()

min

public MongoFindOptions min(org.bson.conversions.Bson min)

getReturnKey

@Nullable
public java.lang.Boolean getReturnKey()

returnKey

public MongoFindOptions returnKey(java.lang.Boolean returnKey)

getShowRecordId

@Nullable
public java.lang.Boolean getShowRecordId()

showRecordId

public MongoFindOptions showRecordId(java.lang.Boolean showRecordId)

getAllowDiskUse

@Nullable
public java.lang.Boolean getAllowDiskUse()

allowDiskUse

public MongoFindOptions allowDiskUse(java.lang.Boolean allowDiskUse)