org.skife.jdbi.v2

Class GeneratedKeys<Type>

java.lang.Object

org.skife.jdbi.v2.GeneratedKeys<Type>

Type Parameters:

Type - the key type returned

All Implemented Interfaces:

Iterable<Type>, ResultBearing<Type>

public class GeneratedKeys<Type>
extends Object
implements ResultBearing<Type>

Wrapper object for generated keys as returned by the Statement.getGeneratedKeys()

Method Summary

Modifier and Type	Method and Description
Type	first() Returns the first generated key.
<T> T	first(Class<T> containerType)
<AccumulatorType> AccumulatorType	fold(AccumulatorType accumulator, Folder2<AccumulatorType> folder) Used to execute the query and traverse the generated keys with a accumulator.
ResultIterator<Type>	iterator() Returns a iterator over all generated keys.
List<Type>	list() Returns a list of all generated keys.
<ContainerType> ContainerType	list(Class<ContainerType> containerType)
List<Type>	list(int maxRows)

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

Method Detail

first

public Type first()

Returns the first generated key.

Specified by:

first in interface ResultBearing<Type>

Returns:

The key or null if no keys were returned

first

public <T> T first(Class<T> containerType)

Specified by:

first in interface ResultBearing<Type>

fold

public <AccumulatorType> AccumulatorType fold(AccumulatorType accumulator,
                                              Folder2<AccumulatorType> folder)

Used to execute the query and traverse the generated keys with a accumulator. Folding over the keys involves invoking a callback for each row, passing into the callback the return value from the previous function invocation.

Parameters:

accumulator - The initial accumulator value

folder - Defines the function which will fold over the result set.

Returns:

The return value from the last invocation of Folder.fold(Object, java.sql.ResultSet)

See Also:

Folder

iterator

public ResultIterator<Type> iterator()

Returns a iterator over all generated keys.

Specified by:

iterator in interface Iterable<Type>

Specified by:

iterator in interface ResultBearing<Type>

Returns:

The key iterator

list

public List<Type> list()

Returns a list of all generated keys.

Specified by:

list in interface ResultBearing<Type>

Returns:

The list of keys or an empty list if no keys were returned

list

public <ContainerType> ContainerType list(Class<ContainerType> containerType)

Specified by:

list in interface ResultBearing<Type>

list

public List<Type> list(int maxRows)

Specified by:

list in interface ResultBearing<Type>