com.mongodb.operation

类 ListIndexesOperation<T>

java.lang.Object

com.mongodb.operation.ListIndexesOperation<T>

类型参数:

T - the operations result type.

所有已实现的接口:

AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>

public class ListIndexesOperation<T>
extends java.lang.Object
implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>

An operation that lists the indexes that have been created on a collection. For flexibility, the type of each document returned is generic.

从以下版本开始:

3.0

MongoDB documentation

List indexes

构造器概要

构造器

构造器和说明
ListIndexesOperation(MongoNamespace namespace, Decoder<T> decoder) Construct a new instance.

方法概要

限定符和类型	方法和说明
ListIndexesOperation<T>	batchSize(int batchSize) Sets the number of documents to return per batch.
BatchCursor<T>	execute(ReadBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback) General execute which can return anything of type T
java.lang.Integer	getBatchSize() Gets the number of documents to return per batch.
long	getMaxTime(java.util.concurrent.TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
ListIndexesOperation<T>	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.

从类继承的方法 java.lang.Object

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

构造器详细资料

ListIndexesOperation

public ListIndexesOperation(MongoNamespace namespace,
                            Decoder<T> decoder)

Construct a new instance.

参数:

namespace - the database and collection namespace for the operation.

decoder - the decoder for the result documents.

方法详细资料

getBatchSize

public java.lang.Integer getBatchSize()

Gets the number of documents to return per batch.

返回:

the batch size

MongoDB documentation

Batch Size

Since server release

3.0

batchSize

public ListIndexesOperation<T> batchSize(int batchSize)

Sets the number of documents to return per batch.

参数:

batchSize - the batch size

返回:

this

MongoDB documentation

Batch Size

Since server release

3.0

getMaxTime

public long getMaxTime(java.util.concurrent.TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

参数:

timeUnit - the time unit to return the result in

返回:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public ListIndexesOperation<T> maxTime(long maxTime,
                                       java.util.concurrent.TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

参数:

maxTime - the max time

timeUnit - the time unit, which may not be null

返回:

this

MongoDB documentation

Max Time

execute

public BatchCursor<T> execute(ReadBinding binding)

从接口复制的说明: ReadOperation

General execute which can return anything of type T

指定者:

execute 在接口中 ReadOperation<BatchCursor<T>>

参数:

binding - the binding to execute in the context of

返回:

T, the result of the execution

executeAsync

public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<AsyncBatchCursor<T>> callback)

从接口复制的说明: AsyncReadOperation

General execute which can return anything of type T

指定者:

executeAsync 在接口中 AsyncReadOperation<AsyncBatchCursor<T>>

参数:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed