com.mongodb.client.MongoIterable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver Show documentation
Show all versions of mongodb-driver Show documentation
The MongoDB Driver uber-artifact that combines mongodb-driver-sync and the legacy driver
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.client;
import com.mongodb.Block;
import com.mongodb.Function;
import com.mongodb.lang.Nullable;
import java.util.Collection;
import java.util.function.Consumer;
/**
*The MongoIterable is the results from an operation, such as a query.
*
* @param The type that this iterable will decode documents to.
* @since 3.0
*/
public interface MongoIterable extends Iterable {
@Override
MongoCursor iterator();
/**
* Helper to return the first item in the iterator or null.
*
* @return T the first item or null.
*/
@Nullable
TResult first();
/**
* Maps this iterable from the source document type to the target document type.
*
* @param mapper a function that maps from the source to the target document type
* @param the target document type
* @return an iterable which maps T to U
*/
MongoIterable map(Function mapper);
/**
* Iterates over all documents in the view, applying the given block to each.
*
* Similar to {@code map} but the function is fully encapsulated with no returned result.
*
* @param block the block to apply to each document of type T.
* @deprecated Prefer {@link Iterable#forEach(Consumer)}, which was added in Java 8
*/
@Deprecated
void forEach(Block super TResult> block);
/**
* Iterates over all the documents, adding each to the given target.
*
* @param target the collection to insert into
* @param the collection type
* @return the target
*/
> A into(A target);
/**
* Sets the number of documents to return per batch.
*
* @param batchSize the batch size
* @return this
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
MongoIterable batchSize(int batchSize);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy