be.bendem.sqlstreams

Interface ParameterProvider<Provider extends ParameterProvider<Provider,Statement>,Statement extends PreparedStatement>

Type Parameters:

Provider - the type of the parent to return from each method of this class

Statement - the type of the statement

All Superinterfaces:

AutoCloseable, Closeable, StatementHolder<Statement>

All Known Subinterfaces:

BatchUpdate, Execute<Statement>, Query, Update

public interface ParameterProvider<Provider extends ParameterProvider<Provider,Statement>,Statement extends PreparedStatement>
extends StatementHolder<Statement>

Represents an object holding a PreparedStatement and providing methods to set it up for a sql query.

Method Summary

Modifier and Type	Method and Description
Provider	prepare(SqlConsumer<Statement> preparator) Prepares an instance of PreparedStatement to be executed.
Provider	set(int index, Object x) Sets the designated parameter based on the type of the parameter given.
Provider	setArray(int index, Array x) Sets the designated parameter to the given Array.
Provider	setAsciiStream(int index, InputStream x) Sets the designated parameter to the given InputStream.
Provider	setAsciiStream(int index, InputStream x, int length) Sets the designated parameter to the given InputStream.
Provider	setAsciiStream(int index, InputStream x, long length) Sets the designated parameter to the given InputStream.
Provider	setBigDecimal(int index, BigDecimal x) Sets the designated parameter to the given BigDecimal.
Provider	setBinaryStream(int index, InputStream x) Sets the designated parameter to the given InputStream.
Provider	setBinaryStream(int index, InputStream x, int length) Sets the designated parameter to the given InputStream.
Provider	setBinaryStream(int index, InputStream x, long length) Sets the designated parameter to the given InputStream.
Provider	setBlob(int index, Blob x) Sets the designated parameter to the given Blob.
Provider	setBlob(int index, InputStream x) Sets the designated parameter to the given InputStream.
Provider	setBlob(int index, InputStream x, long length) Sets the designated parameter to the given InputStream.
Provider	setBoolean(int index, boolean x) Sets the designated parameter to the given boolean.
Provider	setByte(int index, byte x) Sets the designated parameter to the given byte.
Provider	setBytes(int index, byte[] x) Sets the designated parameter to the given byte[].
Provider	setCharacterStream(int index, Reader x) Sets the designated parameter to the given Reader.
Provider	setCharacterStream(int index, Reader x, int length) Sets the designated parameter to the given Reader.
Provider	setCharacterStream(int index, Reader x, long length) Sets the designated parameter to the given Reader.
Provider	setClob(int index, Clob x) Sets the designated parameter to the given Clob.
Provider	setClob(int index, Reader x) Sets the designated parameter to the given Reader.
Provider	setClob(int index, Reader x, long length) Sets the designated parameter to the given Reader.
Provider	setDate(int index, Date x) Sets the designated parameter to the given Date.
Provider	setDate(int index, Date x, Calendar cal) Sets the designated parameter to the given Date.
Provider	setDouble(int index, double x) Sets the designated parameter to the given double.
Provider	setFloat(int index, float x) Sets the designated parameter to the given float.
Provider	setInt(int index, int x) Sets the designated parameter to the given int.
Provider	setLong(int index, long x) Sets the designated parameter to the given long.
Provider	setNCharacterStream(int index, Reader x) Sets the designated parameter to the given Reader.
Provider	setNCharacterStream(int index, Reader x, long length) Sets the designated parameter to the given Reader.
Provider	setNClob(int index, NClob x) Sets the designated parameter to the given NClob.
Provider	setNClob(int index, Reader x) Sets the designated parameter to the given Reader.
Provider	setNClob(int index, Reader x, long length) Sets the designated parameter to the given Reader.
Provider	setNString(int index, String x) Sets the designated parameter to the given String.
Provider	setNull(int index, int sqlType) Sets the designated parameter to the given int.
Provider	setNull(int index, int sqlType, String typeName) Sets the designated parameter to the given int.
Provider	setObject(int index, Object x) Sets the designated parameter to the given Object.
Provider	setObject(int index, Object x, int targetSqlType) Sets the designated parameter to the given Object.
Provider	setObject(int index, Object x, int targetSqlType, int scaleOrLength) Sets the designated parameter to the given Object.
Provider	setObject(int index, Object x, SQLType targetSqlType) Sets the designated parameter to the given Object.
Provider	setObject(int index, Object x, SQLType targetSqlType, int scaleOrLength) Sets the designated parameter to the given Object.
Provider	setRef(int index, Ref x) Sets the designated parameter to the given Ref.
Provider	setRowId(int index, RowId x) Sets the designated parameter to the given RowId.
Provider	setShort(int index, short x) Sets the designated parameter to the given short.
Provider	setSQLXML(int index, SQLXML x) Sets the designated parameter to the given SQLXML.
Provider	setString(int index, String x) Sets the designated parameter to the given String.
Provider	setTime(int index, Time x) Sets the designated parameter to the given Time.
Provider	setTime(int index, Time x, Calendar cal) Sets the designated parameter to the given Time.
Provider	setTimestamp(int index, Timestamp x) Sets the designated parameter to the given Timestamp.
Provider	setTimestamp(int index, Timestamp x, Calendar cal) Sets the designated parameter to the given Timestamp.
Provider	setURL(int index, URL x) Sets the designated parameter to the given URL.
Provider	with(Object... params) Sets multiple parameters using magic bindings.

Methods inherited from interface be.bendem.sqlstreams.StatementHolder

close, execute, getStatement

Method Detail

prepare

Provider prepare(SqlConsumer<Statement> preparator)

Prepares an instance of PreparedStatement to be executed.

Parameters:

preparator - an operation to execute on the statement

Returns:

this for chaining

with

Provider with(Object... params)

Sets multiple parameters using magic bindings.

See here for the types supported by this method.

Parameters:

params - parameters to set

Returns:

this for chaining

set

Provider set(int index,
             Object x)

Sets the designated parameter based on the type of the parameter given.

See here for the types supported by this method.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

Throws:

NullPointerException - if x is null

setArray

Provider setArray(int index,
                  Array x)

Sets the designated parameter to the given Array.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setArray(int, Array)

setAsciiStream

Provider setAsciiStream(int index,
                        InputStream x)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setAsciiStream(int, InputStream)

setAsciiStream

Provider setAsciiStream(int index,
                        InputStream x,
                        int length)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of bytes in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setAsciiStream(int, InputStream, int)

setAsciiStream

Provider setAsciiStream(int index,
                        InputStream x,
                        long length)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of bytes in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setAsciiStream(int, InputStream, long)

setBigDecimal

Provider setBigDecimal(int index,
                       BigDecimal x)

Sets the designated parameter to the given BigDecimal.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBigDecimal(int, BigDecimal)

setBinaryStream

Provider setBinaryStream(int index,
                         InputStream x)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBinaryStream(int, InputStream)

setBinaryStream

Provider setBinaryStream(int index,
                         InputStream x,
                         int length)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of bytes in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setBinaryStream(int, InputStream, int)

setBinaryStream

Provider setBinaryStream(int index,
                         InputStream x,
                         long length)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of bytes in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setBinaryStream(int, InputStream, long)

setBlob

Provider setBlob(int index,
                 Blob x)

Sets the designated parameter to the given Blob.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBlob(int, Blob)

setBlob

Provider setBlob(int index,
                 InputStream x)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBlob(int, InputStream)

setBlob

Provider setBlob(int index,
                 InputStream x,
                 long length)

Sets the designated parameter to the given InputStream.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of bytes in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setBlob(int, InputStream, long)

setBoolean

Provider setBoolean(int index,
                    boolean x)

Sets the designated parameter to the given boolean.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBoolean(int, boolean)

setByte

Provider setByte(int index,
                 byte x)

Sets the designated parameter to the given byte.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setByte(int, byte)

setBytes

Provider setBytes(int index,
                  byte[] x)

Sets the designated parameter to the given byte[].

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setBytes(int, byte[])

setCharacterStream

Provider setCharacterStream(int index,
                            Reader x)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setCharacterStream(int, Reader)

setCharacterStream

Provider setCharacterStream(int index,
                            Reader x,
                            int length)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of characters in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setCharacterStream(int, Reader, int)

setCharacterStream

Provider setCharacterStream(int index,
                            Reader x,
                            long length)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of characters in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setCharacterStream(int, Reader, long)

setClob

Provider setClob(int index,
                 Clob x)

Sets the designated parameter to the given Clob.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setClob(int, Clob)

setClob

Provider setClob(int index,
                 Reader x)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setClob(int, Reader)

setClob

Provider setClob(int index,
                 Reader x,
                 long length)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of characters in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setClob(int, Reader, long)

setDate

Provider setDate(int index,
                 Date x)

Sets the designated parameter to the given Date.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setDate(int, Date)

setDate

Provider setDate(int index,
                 Date x,
                 Calendar cal)

Sets the designated parameter to the given Date.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

cal - the Calendar object the driver will use to construct the date

Returns:

this for chaining

See Also:

PreparedStatement.setDate(int, Date, Calendar)

setDouble

Provider setDouble(int index,
                   double x)

Sets the designated parameter to the given double.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setDouble(int, double)

setFloat

Provider setFloat(int index,
                  float x)

Sets the designated parameter to the given float.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setFloat(int, float)

setInt

Provider setInt(int index,
                int x)

Sets the designated parameter to the given int.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setInt(int, int)

setLong

Provider setLong(int index,
                 long x)

Sets the designated parameter to the given long.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setLong(int, long)

setNCharacterStream

Provider setNCharacterStream(int index,
                             Reader x)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setNCharacterStream(int, Reader)

setNCharacterStream

Provider setNCharacterStream(int index,
                             Reader x,
                             long length)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of characters in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setNCharacterStream(int, Reader, long length)

setNClob

Provider setNClob(int index,
                  NClob x)

Sets the designated parameter to the given NClob.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setNClob(int, NClob)

setNClob

Provider setNClob(int index,
                  Reader x)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setNClob(int, Reader)

setNClob

Provider setNClob(int index,
                  Reader x,
                  long length)

Sets the designated parameter to the given Reader.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

length - the number of characters in the stream

Returns:

this for chaining

See Also:

PreparedStatement.setNClob(int, Reader, long)

setNString

Provider setNString(int index,
                    String x)

Sets the designated parameter to the given String.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setNString(int, String)

setNull

Provider setNull(int index,
                 int sqlType)

Sets the designated parameter to the given int.

Parameters:

index - the index of the parameter to set (starting from 1)

sqlType - the SQL type code defined in Types

Returns:

this for chaining

See Also:

PreparedStatement.setNull(int, int)

setNull

Provider setNull(int index,
                 int sqlType,
                 String typeName)

Sets the designated parameter to the given int.

Parameters:

index - the index of the parameter to set (starting from 1)

sqlType - the SQL type code defined in Types

typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF

Returns:

this for chaining

See Also:

PreparedStatement.setNull(int, int, String)

setObject

Provider setObject(int index,
                   Object x)

Sets the designated parameter to the given Object.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setObject(int, Object)

setObject

Provider setObject(int index,
                   Object x,
                   int targetSqlType)

Sets the designated parameter to the given Object.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

targetSqlType - the SQL type code defined in Types

Returns:

this for chaining

See Also:

PreparedStatement.setObject(int, Object, int)

setObject

Provider setObject(int index,
                   Object x,
                   int targetSqlType,
                   int scaleOrLength)

Sets the designated parameter to the given Object.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

targetSqlType - the SQL type code defined in Types

scaleOrLength - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.

Returns:

this for chaining

See Also:

PreparedStatement.setObject(int, Object, int, int)

setObject

Provider setObject(int index,
                   Object x,
                   SQLType targetSqlType)

Sets the designated parameter to the given Object.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

targetSqlType - the SQL type code defined in Types

Returns:

this for chaining

See Also:

PreparedStatement.setObject(int, Object, SQLType)

setObject

Provider setObject(int index,
                   Object x,
                   SQLType targetSqlType,
                   int scaleOrLength)

Sets the designated parameter to the given Object.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

targetSqlType - the SQL type code defined in Types

scaleOrLength - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.

Returns:

this for chaining

See Also:

PreparedStatement.setObject(int, Object, SQLType, int)

setRef

Provider setRef(int index,
                Ref x)

Sets the designated parameter to the given Ref.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setRef(int, Ref)

setRowId

Provider setRowId(int index,
                  RowId x)

Sets the designated parameter to the given RowId.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setRowId(int, RowId)

setShort

Provider setShort(int index,
                  short x)

Sets the designated parameter to the given short.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setShort(int, short)

setSQLXML

Provider setSQLXML(int index,
                   SQLXML x)

Sets the designated parameter to the given SQLXML.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setSQLXML(int, SQLXML)

setString

Provider setString(int index,
                   String x)

Sets the designated parameter to the given String.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setString(int, String)

setTime

Provider setTime(int index,
                 Time x)

Sets the designated parameter to the given Time.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setTime(int, Time)

setTime

Provider setTime(int index,
                 Time x,
                 Calendar cal)

Sets the designated parameter to the given Time.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

cal - the Calendar object the driver will use to construct the date

Returns:

this for chaining

See Also:

PreparedStatement.setTime(int, Time, Calendar)

setTimestamp

Provider setTimestamp(int index,
                      Timestamp x)

Sets the designated parameter to the given Timestamp.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setTimestamp(int, Timestamp)

setTimestamp

Provider setTimestamp(int index,
                      Timestamp x,
                      Calendar cal)

Sets the designated parameter to the given Timestamp.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

cal - the Calendar object the driver will use to construct the date

Returns:

this for chaining

See Also:

PreparedStatement.setTimestamp(int, Timestamp, Calendar)

setURL

Provider setURL(int index,
                URL x)

Sets the designated parameter to the given URL.

Parameters:

index - the index of the parameter to set (starting from 1)

x - the value to set

Returns:

this for chaining

See Also:

PreparedStatement.setURL(int, URL)