CollectionCallback

java.lang.Object
- com.redwood.scheduler.api.model.CollectionCallback<T>

Type Parameters:

T - The type of object that is expected in the collection. Note, this is not checked at runtime, it is up to the caller to ensure that the query returns the correct object type. Caveat Emptor!

All Implemented Interfaces:

APIResultSetCallback
```
public class CollectionCallback<T>
extends Object
implements APIResultSetCallback
```
Add all objects to the specified collection.

Field Summary
- Fields inherited from interface com.redwood.scheduler.api.model.APIResultSetCallback
  NULL

Constructor Summary

Constructors
Constructor Description

CollectionCallback(Collection<T> newCollection)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`callback(ResultSet rs, ObjectGetter objectGetter)`	Invoked for each result, provided that the previous invocation returned `true`.
`void`	`start()`	Invoked before processing any results.

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

Methods inherited from interface com.redwood.scheduler.api.model.APIResultSetCallback
finish

- Constructor Detail
  - CollectionCallback
```
public CollectionCallback(Collection<T> newCollection)
```
- Method Detail
  - start
```
public void start()
```
    Description copied from interface: APIResultSetCallback
    
    Invoked before processing any results.
    This is before any calls to APIResultSetCallback.callback(ResultSet, ObjectGetter) are made.
    Note that this may be invoked more than once under some circumstances. (Such circumstances include when the query is restarted due to underlying database errors.)
    
    Specified by:
    
    start in interface APIResultSetCallback
  - callback
```
public boolean callback(ResultSet rs,
                        ObjectGetter objectGetter)
                 throws SQLException
```
    Description copied from interface: APIResultSetCallback
    
    Invoked for each result, provided that the previous invocation returned true.
    
    Specified by:
    
    callback in interface APIResultSetCallback
    
    Parameters:
    
    rs - the result-set to process
    
    objectGetter - an object-getter with can be used to convert the result-set into one (or more) objects.
    
    Returns:
    
    true if this method should be invoked for the next result, false if subsequent results are to be discarded.
    
    Throws:
    
    SQLException - Exception thrown when a database-related error occurs