org.springframework.data.mongodb.core.query

Class Meta

java.lang.Object

org.springframework.data.mongodb.core.query.Meta

public class Meta
extends Object

Meta-data for Query instances.

Since:

1.6

Author:

Christoph Strobl, Oliver Gierke, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Meta.CursorOption Meta.CursorOption represents OP_QUERY wire protocol flags to change the behavior of queries.

Constructor Summary

Constructors

Constructor and Description
Meta()

Method Summary

Modifier and Type	Method and Description
boolean	addFlag(Meta.CursorOption option) Add Meta.CursorOption influencing behavior of the DBCursor.
boolean	equals(Object obj)
String	getComment()
Set<Meta.CursorOption>	getFlags()
Long	getMaxScan()
Long	getMaxTimeMsec()
boolean	getSnapshot()
int	hashCode()
boolean	hasValues()
void	setComment(String comment) Add a comment to the query.
void	setMaxScan(long maxScan) Only scan the specified number of documents.
void	setMaxTime(long timeout, TimeUnit timeUnit) Set the maximum time limit for processing operations.
void	setMaxTimeMsec(long maxTimeMsec) Set the maximum time limit in milliseconds for processing operations.
void	setSnapshot(boolean useSnapshot) Using snapshot prevents the cursor from returning a document more than once.
Iterable<Map.Entry<String,Object>>	values() Get Iterable of set meta values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Meta

public Meta()

Method Detail

getMaxTimeMsec

public Long getMaxTimeMsec()

Returns:

null if not set.

setMaxTimeMsec

public void setMaxTimeMsec(long maxTimeMsec)

Set the maximum time limit in milliseconds for processing operations.

Parameters:

maxTimeMsec -

setMaxTime

public void setMaxTime(long timeout,
                       TimeUnit timeUnit)

Set the maximum time limit for processing operations.

Parameters:

timeout -

timeUnit -

getMaxScan

public Long getMaxScan()

Returns:

null if not set.

setMaxScan

public void setMaxScan(long maxScan)

Only scan the specified number of documents.

Parameters:

maxScan -

setComment

public void setComment(String comment)

Add a comment to the query.

Parameters:

comment -

getComment

public String getComment()

Returns:

null if not set.

setSnapshot

public void setSnapshot(boolean useSnapshot)

Using snapshot prevents the cursor from returning a document more than once.

Parameters:

useSnapshot -

getSnapshot

public boolean getSnapshot()

Returns:

null if not set.

addFlag

public boolean addFlag(Meta.CursorOption option)

Add Meta.CursorOption influencing behavior of the DBCursor.

Parameters:

option - must not be null.

Returns:

Since:

1.10

getFlags

public Set<Meta.CursorOption> getFlags()

Returns:

never null.

Since:

1.10

hasValues

public boolean hasValues()

Returns:

values

public Iterable<Map.Entry<String,Object>> values()

Get Iterable of set meta values.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object