Class ResultProducers

java.lang.Object

org.jdbi.v3.core.result.ResultProducers

All Implemented Interfaces:

JdbiConfig<ResultProducers>

public class ResultProducers
extends Object
implements JdbiConfig<ResultProducers>

Commonly used ResultProducer implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResultProducers.ResultSetCreator	Returns a ResultSet from a Statement.

Constructor Summary

Constructors

Constructor	Description
ResultProducers()

Method Summary

Modifier and Type	Method	Description
ResultProducers	allowNoResults(boolean allowNoResults)	Normally a query that doesn't return a result set throws an exception.
ResultProducers	createCopy()	Returns a copy of this configuration object.
static ResultBearing	createResultBearing(Supplier<PreparedStatement> preparedStatementSupplier, ResultProducers.ResultSetCreator resultSetCreator, StatementContext ctx)	Create a ResultBearing instance backed by a ResultSet.
static ResultProducer<ResultBearing>	returningGeneratedKeys(String... generatedKeyColumnNames)	Result producer that returns a ResultBearing over the statement-generated keys.
static ResultProducer<Long>	returningLargeUpdateCount()	Result producer that eagerly executes the statement, returning the large update count
static ResultProducer<ResultBearing>	returningResults()	Result producer that returns a ResultBearing over the statement result rows.
static ResultProducer<Integer>	returningUpdateCount()	Result producer that eagerly executes the statement, returning the update count

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface JdbiConfig

setRegistry

Modifier and Type	Method	Description
default void	setRegistry(ConfigRegistry registry)	The registry will inject itself into the configuration object.

Constructor Details

ResultProducers

public ResultProducers()

Method Details

returningUpdateCount

public static ResultProducer<Integer> returningUpdateCount()

Result producer that eagerly executes the statement, returning the update count

Returns:

update count

See Also:

• Statement.getUpdateCount()

returningLargeUpdateCount

public static ResultProducer<Long> returningLargeUpdateCount()

Result producer that eagerly executes the statement, returning the large update count

Returns:

long update count

See Also:

• Statement.getLargeUpdateCount()

returningResults

public static ResultProducer<ResultBearing> returningResults()

Result producer that returns a ResultBearing over the statement result rows.

Returns:

ResultBearing of result rows.

See Also:

• Statement.getResultSet()

returningGeneratedKeys

public static ResultProducer<ResultBearing> returningGeneratedKeys(String... generatedKeyColumnNames)

Result producer that returns a ResultBearing over the statement-generated keys.

Parameters:

generatedKeyColumnNames - optional list of generated key column names.

Returns:

ResultBearing of generated keys

See Also:

• Statement.getGeneratedKeys()

createResultBearing

public static ResultBearing createResultBearing(Supplier<PreparedStatement> preparedStatementSupplier,
 ResultProducers.ResultSetCreator resultSetCreator,
 StatementContext ctx)

Create a ResultBearing instance backed by a ResultSet. This method can be used to create other ResultProducer instances that manage a ResultBearing instance.

Parameters:

preparedStatementSupplier - Provides the PreparedStatement to obtain the ResultSet.

resultSetCreator - Creates a ResultSet from a Statement.

ctx - The statement context.

Returns:

An instance of ResultBearing that is backed by the ResultSet.

createCopy

public ResultProducers createCopy()

Description copied from interface: JdbiConfig

Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.

Specified by:

createCopy in interface JdbiConfig<ResultProducers>

Returns:

a copy of this configuration object.

allowNoResults

public ResultProducers allowNoResults(boolean allowNoResults)

Normally a query that doesn't return a result set throws an exception. With this option, we will replace it with an empty result set instead.

Parameters:

allowNoResults - True if an empty ResultSet object should be returned, false if a NoResultsException should be thrown.

Returns:

this