Package com.mongodb.operation

Class ListIndexesOperation<T>

java.lang.Object

com.mongodb.operation.ListIndexesOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

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

public class ListIndexesOperation<T>
extends 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.

Since:

3.0

MongoDB documentation

List indexes

Constructor Summary

Constructors

Constructor	Description
ListIndexesOperation(MongoNamespace namespace, Decoder<T> decoder)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
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
Integer	getBatchSize()	Gets the number of documents to return per batch.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
ListIndexesOperation<T>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListIndexesOperation

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

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

decoder - the decoder for the result documents.

Method Detail

getBatchSize

public Integer getBatchSize()

Gets the number of documents to return per batch.

Returns:

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.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

Since server release

3.0

getMaxTime

public long getMaxTime(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.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public ListIndexesOperation<T> maxTime(long maxTime,
                                       TimeUnit timeUnit)

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

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

execute

public BatchCursor<T> execute(ReadBinding binding)

Description copied from interface: ReadOperation

General execute which can return anything of type T

Specified by:

execute in interface ReadOperation<T>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

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

Description copied from interface: AsyncReadOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncReadOperation<T>

Parameters:

binding - the binding to execute in the context of

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