Package de.chojo.sqlutil.wrapper

Class ParamBuilder

java.lang.Object
de.chojo.sqlutil.wrapper.ParamBuilder
public class ParamBuilder extends Object
A class which wrapps a PreparedStatement and allows to set the values with a builder pattern.

The index of the argument will be moved automatically

  • Constructor Details

    • ParamBuilder

      public ParamBuilder(PreparedStatement stmt)
      Create a new ParamBuilder
      Parameters:
      stmt - statement to wrap

  • Method Details

    • setNull

      public ParamBuilder setNull(int sqlType) throws SQLException
      Sets the designated parameter to SQL NULL.

      Note: You must specify the parameter's SQL type.

      Parameters:
      sqlType - the SQL type code defined in java.sql.Types
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

    • setBoolean

      public ParamBuilder setBoolean(Boolean x) throws SQLException
      Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setByte

      public ParamBuilder setByte(Byte x) throws SQLException
      Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setShort

      public ParamBuilder setShort(Short x) throws SQLException
      Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setInt

      public ParamBuilder setInt(Integer x) throws SQLException
      Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setLong

      public ParamBuilder setLong(Long x) throws SQLException
      Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setFloat

      public ParamBuilder setFloat(Float x) throws SQLException
      Sets the designated parameter to the given Java float value. The driver converts this to an SQL REAL value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setDouble

      public ParamBuilder setDouble(Double x) throws SQLException
      Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setBigDecimal

      public ParamBuilder setBigDecimal(BigDecimal x) throws SQLException
      Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setString

      public ParamBuilder setString(String x) throws SQLException
      Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setBytes

      public ParamBuilder setBytes(byte[] x) throws SQLException
      Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setDate

      public ParamBuilder setDate(Date x) throws SQLException
      Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQL DATE value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setTime

      public ParamBuilder setTime(Time x) throws SQLException
      Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setTimestamp

      public ParamBuilder setTimestamp(Timestamp x) throws SQLException
      Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setAsciiStream

      public ParamBuilder setAsciiStream(InputStream x, int length) throws SQLException
      Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      x - the Java input stream that contains the ASCII parameter value
      length - the number of bytes in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setBinaryStream

      public ParamBuilder setBinaryStream(InputStream x, int length) throws SQLException
      Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      x - the java input stream which contains the binary parameter value
      length - the number of bytes in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

    • setObject

      public ParamBuilder setObject(Object x, int targetSqlType) throws SQLException
      Sets the value of the designated parameter with the given object.

      This method is similar to setObject(Object x, int targetSqlType, int scaleOrLength), except that it assumes a scale of zero.

      Parameters:
      x - the object containing the input parameter value
      targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      See Also:

    • setObject

      public ParamBuilder setObject(Object x) throws SQLException

      Sets the value of the designated parameter using the given object.

      The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

      Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type.

      If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, RowId, SQLXML or Array, the driver should pass it to the database as a value of the corresponding SQL type.

      Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(Object x, int sqlType) method should be used instead of setObject(Object x).

      Note: This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.

      Parameters:
      x - the object containing the input parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or the type of the given object is ambiguous

    • setCharacterStream

      public ParamBuilder setCharacterStream(Reader reader, int length) throws SQLException
      Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      reader - the java.io.Reader object that contains the Unicode data
      length - the number of characters in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      Since:
      1.2

    • setRef

      public ParamBuilder setRef(Ref x) throws SQLException
      Sets the designated parameter to the given REF(<structured-type>) value. The driver converts this to an SQL REF value when it sends it to the database.
      Parameters:
      x - an SQL REF value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setBlob

      public ParamBuilder setBlob(Blob x) throws SQLException
      Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.
      Parameters:
      x - a Blob object that maps an SQL BLOB value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setClob

      public ParamBuilder setClob(Clob x) throws SQLException
      Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.
      Parameters:
      x - a Clob object that maps an SQL CLOB value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setArray

      public ParamBuilder setArray(Array x) throws SQLException
      Sets the designated parameter to the given java.sql.Array object. The driver converts this to an SQL ARRAY value when it sends it to the database.
      Parameters:
      x - an Array object that maps an SQL ARRAY value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setURL

      public ParamBuilder setURL(URL x) throws SQLException
      Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.
      Parameters:
      x - the java.net.URL object to be set
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.4

    • setRowId

      public ParamBuilder setRowId(RowId x) throws SQLException
      Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database
      Parameters:
      x - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNString

      public ParamBuilder setNString(String value) throws SQLException
      Sets the designated parameter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the database.
      Parameters:
      value - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNCharacterStream

      public ParamBuilder setNCharacterStream(Reader value, long length) throws SQLException
      Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.
      Parameters:
      value - the parameter value
      length - the number of characters in the parameter data.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNClob

      public ParamBuilder setNClob(NClob value) throws SQLException
      Sets the designated parameter to a java.sql.NClob object. The driver converts this to a SQL NCLOB value when it sends it to the database.
      Parameters:
      value - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setClob

      public ParamBuilder setClob(Reader reader, long length) throws SQLException
      Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB
      Parameters:
      reader - An object that contains the data to set the parameter value to.
      length - the number of characters in the parameter data.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if the length specified is less than zero.
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBlob

      public ParamBuilder setBlob(InputStream inputStream, long length) throws SQLException
      Sets the designated parameter to a InputStream object. The Inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB
      Parameters:
      inputStream - An object that contains the data to set the parameter value to.
      length - the number of bytes in the parameter data.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement; if the length specified is less than zero or if the number of bytes in the InputStream does not match the specified length.
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNClob

      public ParamBuilder setNClob(Reader reader, long length) throws SQLException
      Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB
      Parameters:
      reader - An object that contains the data to set the parameter value to.
      length - the number of characters in the parameter data.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setSQLXML

      public ParamBuilder setSQLXML(SQLXML xmlObject) throws SQLException
      Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.
      Parameters:
      xmlObject - a SQLXML object that maps an SQL XML value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setObject

      public ParamBuilder setObject(Object x, int targetSqlType, int scaleOrLength) throws SQLException

      Sets the value of the designated parameter with the given object.

      If the second argument is an InputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate a SQLException when the prepared statement is executed.

      The given Java object will be converted to the given targetSqlType before being sent to the database.

      If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

      Note that this method may be used to pass database-specific abstract data types.

      Parameters:
      x - the object containing the input parameter value
      targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
      scaleOrLength - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, 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:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      See Also:

    • setAsciiStream

      public ParamBuilder setAsciiStream(InputStream x, long length) throws SQLException
      Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      x - the Java input stream that contains the ASCII parameter value
      length - the number of bytes in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      Since:
      1.6

    • setBinaryStream

      public ParamBuilder setBinaryStream(InputStream x, long length) throws SQLException
      Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      x - the java input stream which contains the binary parameter value
      length - the number of bytes in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      Since:
      1.6

    • setCharacterStream

      public ParamBuilder setCharacterStream(Reader reader, long length) throws SQLException
      Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Parameters:
      reader - the java.io.Reader object that contains the Unicode data
      length - the number of characters in the stream
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      Since:
      1.6

    • setAsciiStream

      public ParamBuilder setAsciiStream(InputStream x) throws SQLException
      Sets the designated parameter to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.

      Parameters:
      x - the Java input stream that contains the ASCII parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBinaryStream

      public ParamBuilder setBinaryStream(InputStream x) throws SQLException
      Sets the designated parameter to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.

      Parameters:
      x - the java input stream which contains the binary parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setCharacterStream

      public ParamBuilder setCharacterStream(Reader reader) throws SQLException
      Sets the designated parameter to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.

      Parameters:
      reader - the java.io.Reader object that contains the Unicode data
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNCharacterStream

      public ParamBuilder setNCharacterStream(Reader value) throws SQLException
      Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

      Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.

      Parameters:
      value - the parameter value
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setClob

      public ParamBuilder setClob(Reader reader) throws SQLException
      Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.

      Parameters:
      reader - An object that contains the data to set the parameter value to.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBlob

      public ParamBuilder setBlob(InputStream inputStream) throws SQLException
      Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.

      Parameters:
      inputStream - An object that contains the data to set the parameter value to.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if parameterIndex does not correspond to a parameter marker in the SQL statement,
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNClob

      public ParamBuilder setNClob(Reader reader) throws SQLException
      Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.

      Parameters:
      reader - An object that contains the data to set the parameter value to.
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setObject

      public ParamBuilder setObject(Object x, SQLType targetSqlType) throws SQLException
      Sets the value of the designated parameter with the given object.

      This method is similar to setObject(Object, int, int), except that it assumes a scale of zero.

      The default implementation will throw SQLFeatureNotSupportedException

      Parameters:
      x - the object containing the input parameter value
      targetSqlType - the SQL type to be sent to the database
      Returns:
      ParamBuilder with values set.
      Throws:
      SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      Since:
      1.8
      See Also: