org.jdbi.v3.core.result

Interface ResultSetMapper<T>

Type Parameters:

T - the mapped type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ResultSetMapper<T>

Maps result sets to objects.

See Also:

ResultBearing.mapResultSet(ResultSetMapper)

Method Summary

Modifier and Type	Method and Description
T	mapResultSet(Supplier<ResultSet> resultSetSupplier, StatementContext ctx) Maps the lazily-supplied result set into an object.

Method Detail

mapResultSet

T mapResultSet(Supplier<ResultSet> resultSetSupplier,
               StatementContext ctx)
        throws SQLException

Maps the lazily-supplied result set into an object. The result set is not opened (and typically, the statement the result came from is not executed) until resultSetSupplier.get() is called.

Implementors that call resultSetSupplier.get() must ensure that the statement context is closed, to ensure that database resources are freed:

 try {
     ResultSet resultSet = resultSetSupplier.get()
     // generate and return result from the result set.
 }
 finally {
     ctx.close();
 }
 

Alternatively, implementors may return some intermediate result object (e.g. ResultIterable) without calling resultSetSupplier.get(), in which case the burden of closing resources falls to whichever object ultimately does get() the result set.

Parameters:

resultSetSupplier - supplies a ResultSet.

ctx - the statement context.

Returns:

the mapped result

Throws:

SQLException - if anything goes wrong