com.mongodb.operation

类 ListCollectionsOperation<T>

java.lang.Object

com.mongodb.operation.ListCollectionsOperation<T>

类型参数:

T - the document type

所有已实现的接口:

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

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

An operation that provides a cursor allowing iteration through the metadata of all the collections in a database. This operation ensures that the value of the name field of each returned document is the simple name of the collection rather than the full namespace.

从以下版本开始:

3.0

构造器概要

构造器

构造器和说明
ListCollectionsOperation(java.lang.String databaseName, Decoder<T> decoder) Construct a new instance.

方法概要

限定符和类型	方法和说明
ListCollectionsOperation<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
ListCollectionsOperation<T>	filter(BsonDocument filter) Sets the query filter to apply to the query.
java.lang.Integer	getBatchSize() Gets the number of documents to return per batch.
BsonDocument	getFilter() Gets the query filter.
long	getMaxTime(java.util.concurrent.TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
ListCollectionsOperation<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

构造器详细资料

ListCollectionsOperation

public ListCollectionsOperation(java.lang.String databaseName,
                                Decoder<T> decoder)

Construct a new instance.

参数:

databaseName - the name of the database for the operation.

decoder - the decoder to use for the results

方法详细资料

getFilter

public BsonDocument getFilter()

Gets the query filter.

返回:

the query filter

MongoDB documentation

Filter

filter

public ListCollectionsOperation<T> filter(BsonDocument filter)

Sets the query filter to apply to the query.

参数:

filter - the filter, which may be null.

返回:

this

MongoDB documentation

Filter

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 ListCollectionsOperation<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 ListCollectionsOperation<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