GridFSFindIterableImpl

java.lang.Object
- com.mongodb.client.gridfs.GridFSFindIterableImpl

All Implemented Interfaces:

GridFSFindIterable, MongoIterable<GridFSFile>, java.lang.Iterable<GridFSFile>
```
class GridFSFindIterableImpl
extends java.lang.Object
implements GridFSFindIterable
```

Field Summary

Fields
Modifier and Type Field and Description

private FindIterable<GridFSFile> underlying

Fields
Modifier and Type	Field and Description
`private FindIterable<GridFSFile>`	`underlying`

Constructor Summary

Constructors
Constructor and Description

GridFSFindIterableImpl(FindIterable<GridFSFile> underlying)

Constructors
Constructor and Description
`GridFSFindIterableImpl(FindIterable<GridFSFile> underlying)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GridFSFindIterable`	`batchSize(int batchSize)` Sets the number of documents to return per batch.
`GridFSFindIterable`	`collation(Collation collation)` Sets the collation options
`GridFSFindIterable`	`filter(Bson filter)` Sets the query filter to apply to the query.
`GridFSFile`	`first()` Helper to return the first item in the iterator or null.
`void`	`forEach(Block<? super GridFSFile> block)` Iterates over all documents in the view, applying the given block to each.
`<A extends java.util.Collection<? super GridFSFile>> A`	`into(A target)` Iterates over all the documents, adding each to the given target.
`MongoCursor<GridFSFile>`	`iterator()`
`GridFSFindIterable`	`limit(int limit)` Sets the limit to apply.
`<U> MongoIterable<U>`	`map(Function<GridFSFile,U> mapper)` Maps this iterable from the source document type to the target document type.
`GridFSFindIterable`	`maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.
`GridFSFindIterable`	`noCursorTimeout(boolean noCursorTimeout)` The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
`GridFSFindIterable`	`skip(int skip)` Sets the number of documents to skip.
`GridFSFindIterable`	`sort(Bson sort)` Sets the sort criteria to apply to the query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - underlying
```
private final FindIterable<GridFSFile> underlying
```
- Constructor Detail
  - GridFSFindIterableImpl
```
public GridFSFindIterableImpl(FindIterable<GridFSFile> underlying)
```
- Method Detail
  - sort
```
public GridFSFindIterable sort(Bson sort)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the sort criteria to apply to the query.
    
    Specified by:
    
    sort in interface GridFSFindIterable
    
    Parameters:
    
    sort - the sort criteria, which may be null.
    
    Returns:
    
    this
  - skip
```
public GridFSFindIterable skip(int skip)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the number of documents to skip.
    
    Specified by:
    
    skip in interface GridFSFindIterable
    
    Parameters:
    
    skip - the number of documents to skip
    
    Returns:
    
    this
  - limit
```
public GridFSFindIterable limit(int limit)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the limit to apply.
    
    Specified by:
    
    limit in interface GridFSFindIterable
    
    Parameters:
    
    limit - the limit, which may be null
    
    Returns:
    
    this
  - filter
```
public GridFSFindIterable filter(Bson filter)
```
    Description copied from interface: GridFSFindIterable
    Sets the query filter to apply to the query.
    Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data:
```
  
      Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
  
  
```
    Specified by:
    
    filter in interface GridFSFindIterable
    
    Parameters:
    
    filter - the filter, which may be null.
    
    Returns:
    
    this
    
    See Also:
    
    Filters
  - maxTime
```
public GridFSFindIterable maxTime(long maxTime,
                                  java.util.concurrent.TimeUnit timeUnit)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the maximum execution time on the server for this operation.
    
    Specified by:
    
    maxTime in interface GridFSFindIterable
    
    Parameters:
    
    maxTime - the max time
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
  - batchSize
```
public GridFSFindIterable batchSize(int batchSize)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the number of documents to return per batch.
    
    Specified by:
    
    batchSize in interface GridFSFindIterable
    
    Specified by:
    
    batchSize in interface MongoIterable<GridFSFile>
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
  - collation
```
public GridFSFindIterable collation(Collation collation)
```
    Description copied from interface: GridFSFindIterable
    
    Sets the collation options
    A null value represents the server default.
    
    Specified by:
    
    collation in interface GridFSFindIterable
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
  - noCursorTimeout
```
public GridFSFindIterable noCursorTimeout(boolean noCursorTimeout)
```
    Description copied from interface: GridFSFindIterable
    
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
    
    Specified by:
    
    noCursorTimeout in interface GridFSFindIterable
    
    Parameters:
    
    noCursorTimeout - true if cursor timeout is disabled
    
    Returns:
    
    this
  - iterator
```
public MongoCursor<GridFSFile> iterator()
```
    Specified by:
    
    iterator in interface MongoIterable<GridFSFile>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<GridFSFile>
  - first
```
public GridFSFile first()
```
    Description copied from interface: MongoIterable
    
    Helper to return the first item in the iterator or null.
    
    Specified by:
    
    first in interface MongoIterable<GridFSFile>
    
    Returns:
    
    T the first item or null.
  - map
```
public <U> MongoIterable<U> map(Function<GridFSFile,U> mapper)
```
    Description copied from interface: MongoIterable
    
    Maps this iterable from the source document type to the target document type.
    
    Specified by:
    
    map in interface MongoIterable<GridFSFile>
    
    Type Parameters:
    
    U - the target document type
    
    Parameters:
    
    mapper - a function that maps from the source to the target document type
    
    Returns:
    
    an iterable which maps T to U
  - forEach
```
public void forEach(Block<? super GridFSFile> block)
```
    Description copied from interface: MongoIterable
    
    Iterates over all documents in the view, applying the given block to each.
    Similar to map but the function is fully encapsulated with no returned result.
    
    Specified by:
    
    forEach in interface MongoIterable<GridFSFile>
    
    Parameters:
    
    block - the block to apply to each document of type T.
  - into
```
public <A extends java.util.Collection<? super GridFSFile>> A into(A target)
```
    Description copied from interface: MongoIterable
    
    Iterates over all the documents, adding each to the given target.
    
    Specified by:
    
    into in interface MongoIterable<GridFSFile>
    
    Type Parameters:
    
    A - the collection type
    
    Parameters:
    
    target - the collection to insert into
    
    Returns:
    
    the target

Class GridFSFindIterableImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

underlying

Constructor Detail

GridFSFindIterableImpl

Method Detail

sort

skip

limit

filter

maxTime

batchSize

collation

noCursorTimeout

iterator

first

map

forEach

into