ListResultSet (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.index.query.ListResultSet<T>

All Implemented Interfaces:: ResultSet<T>, Iterable<T>

public class ListResultSet<T>
extends Object
implements ResultSet<T>

Constructor Summary

Constructors
Constructor Description

ListResultSet(List<T> r)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the result, discarding any further results.
`Iterator<T>`	`iterator()`	Obtain an iterator to loop through the results.
`com.google.common.collect.ImmutableList<T>`	`toList()`	Materialize all results as a single list.

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

- Constructor Detail
  - ListResultSet
```
public ListResultSet(List<T> r)
```
- Method Detail
  - iterator
```
public Iterator<T> iterator()
```
    Description copied from interface: ResultSet
    
    Obtain an iterator to loop through the results.
    The iterator can be obtained only once. When the iterator completes ( hasNext() returns false) ResultSet.close() will be automatically called.
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface ResultSet<T>
  - toList
```
public com.google.common.collect.ImmutableList<T> toList()
```
    Description copied from interface: ResultSet
    
    Materialize all results as a single list.
    Prior to returning ResultSet.close() is invoked. This method must not be combined with ResultSet.iterator() on the same instance.
    
    Specified by:
    
    toList in interface ResultSet<T>
    
    Returns:
    
    immutable list of the complete results.
  - close
```
public void close()
```
    Description copied from interface: ResultSet
    
    Close the result, discarding any further results.
    This method may be invoked more than once. Its main use is to stop obtaining results before the iterator has finished.
    
    Specified by:
    
    close in interface ResultSet<T>