jdk.sql.SQLInput — clojure-interop/java.sql 1.0.5

An input stream that contains a stream of values representing an instance of an SQL structured type or an SQL distinct type. This interface, used only for custom mapping, is used by the driver behind the scenes, and a programmer never directly invokes SQLInput methods. The reader methods (readLong, readBytes, and so on) provide a way for an implementation of the SQLData interface to read the values in an SQLInput object. And as described in SQLData, calls to reader methods must be made in the order that their corresponding attributes appear in the SQL definition of the type. The method wasNull is used to determine whether the last value read was SQL NULL. When the method getObject is called with an object of a class implementing the interface SQLData, the JDBC driver calls the method SQLData.getSQLType to determine the SQL type of the user-defined type (UDT) being custom mapped. The driver creates an instance of SQLInput, populating it with the attributes of the UDT. The driver then passes the input stream to the method SQLData.readSQL, which in turn calls the SQLInput reader methods in its implementation for reading the attributes from the input stream.

read-array clj

(read-array this)

Reads an SQL ARRAY value from the stream and returns it as an Array object in the Java programming language.

returns: an Array object representing data of the SQL ARRAY value at the head of the stream; null if the value read is SQL NULL - java.sql.Array

throws: java.sql.SQLException - if a database access error occurs

read-ascii-stream clj

(read-ascii-stream this)

Reads the next attribute in the stream and returns it as a stream of ASCII characters.

returns: the attribute; if the value is SQL NULL, returns null - java.io.InputStream

throws: java.sql.SQLException - if a database access error occurs

read-big-decimal clj

(read-big-decimal this)

Reads the next attribute in the stream and returns it as a java.math.BigDecimal object in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns null - java.math.BigDecimal

throws: java.sql.SQLException - if a database access error occurs

read-binary-stream clj

(read-binary-stream this)

Reads the next attribute in the stream and returns it as a stream of uninterpreted bytes.

returns: the attribute; if the value is SQL NULL, returns null - java.io.InputStream

throws: java.sql.SQLException - if a database access error occurs

read-blob clj

(read-blob this)

Reads an SQL BLOB value from the stream and returns it as a Blob object in the Java programming language.

returns: a Blob object representing data of the SQL BLOB value at the head of the stream; null if the value read is SQL NULL - java.sql.Blob

throws: java.sql.SQLException - if a database access error occurs

read-boolean clj

(read-boolean this)

Reads the next attribute in the stream and returns it as a boolean in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns false - boolean

throws: java.sql.SQLException - if a database access error occurs

read-byte clj

(read-byte this)

Reads the next attribute in the stream and returns it as a byte in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - byte

throws: java.sql.SQLException - if a database access error occurs

read-bytes clj

(read-bytes this)

Reads the next attribute in the stream and returns it as an array of bytes in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns null - byte[]

throws: java.sql.SQLException - if a database access error occurs

read-character-stream clj

(read-character-stream this)

Reads the next attribute in the stream and returns it as a stream of Unicode characters.

returns: the attribute; if the value is SQL NULL, returns null - java.io.Reader

throws: java.sql.SQLException - if a database access error occurs

read-clob clj

(read-clob this)

Reads an SQL CLOB value from the stream and returns it as a Clob object in the Java programming language.

returns: a Clob object representing data of the SQL CLOB value at the head of the stream; null if the value read is SQL NULL - java.sql.Clob

throws: java.sql.SQLException - if a database access error occurs

read-date clj

(read-date this)

Reads the next attribute in the stream and returns it as a java.sql.Date object.

returns: the attribute; if the value is SQL NULL, returns null - java.sql.Date

throws: java.sql.SQLException - if a database access error occurs

read-double clj

(read-double this)

Reads the next attribute in the stream and returns it as a double in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - double

throws: java.sql.SQLException - if a database access error occurs

read-float clj

(read-float this)

Reads the next attribute in the stream and returns it as a float in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - float

throws: java.sql.SQLException - if a database access error occurs

read-int clj

(read-int this)

Reads the next attribute in the stream and returns it as an int in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - int

throws: java.sql.SQLException - if a database access error occurs

read-long clj

(read-long this)

Reads the next attribute in the stream and returns it as a long in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - long

throws: java.sql.SQLException - if a database access error occurs

read-n-clob clj

(read-n-clob this)

Reads an SQL NCLOB value from the stream and returns it as a NClob object in the Java programming language.

returns: a NClob object representing data of the SQL NCLOB value at the head of the stream; null if the value read is SQL NULL - java.sql.NClob

throws: java.sql.SQLException - if a database access error occurs

read-n-string clj

(read-n-string this)

Reads the next attribute in the stream and returns it as a String in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR columns.

returns: the attribute; if the value is SQL NULL, returns null - java.lang.String

throws: java.sql.SQLException - if a database access error occurs

read-object clj

(read-object this)

(read-object this type)

Reads the next attribute in the stream and returns it as an Object in the Java programming language. The actual type of the object returned is determined by the specified Java data type, and any customizations present in this stream's type map.

A type map is registered with the stream by the JDBC driver before the stream is passed to the application.

When the attribute at the head of the stream is an SQL NULL the method returns null. If the attribute is an SQL structured or distinct type, it determines the SQL type of the attribute at the head of the stream. If the stream's type map has an entry for that SQL type, the driver constructs an object of the appropriate class and calls the method SQLData.readSQL on that object, which reads additional data from the stream, using the protocol described for that method.

The default implementation will throw SQLFeatureNotSupportedException

type - Class representing the Java data type to convert the attribute to. - java.lang.Class

returns: the attribute at the head of the stream as an Object in the Java programming language;null if the attribute is SQL NULL - default <T> T

throws: java.sql.SQLException - if a database access error occurs

read-ref clj

(read-ref this)

Reads an SQL REF value from the stream and returns it as a Ref object in the Java programming language.

returns: a Ref object representing the SQL REF value at the head of the stream; null if the value read is SQL NULL - java.sql.Ref

throws: java.sql.SQLException - if a database access error occurs

read-row-id clj

(read-row-id this)

Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.

returns: a RowId object representing data of the SQL ROWID value at the head of the stream; null if the value read is SQL NULL - java.sql.RowId

throws: java.sql.SQLException - if a database access error occurs

read-short clj

(read-short this)

Reads the next attribute in the stream and returns it as a short in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns 0 - short

throws: java.sql.SQLException - if a database access error occurs

read-sqlxml clj

(read-sqlxml this)

Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.

returns: a SQLXML object representing data of the SQL XML value at the head of the stream; null if the value read is SQL NULL - java.sql.SQLXML

throws: java.sql.SQLException - if a database access error occurs

read-string clj

(read-string this)

Reads the next attribute in the stream and returns it as a String in the Java programming language.

returns: the attribute; if the value is SQL NULL, returns null - java.lang.String

throws: java.sql.SQLException - if a database access error occurs

read-time clj

(read-time this)

Reads the next attribute in the stream and returns it as a java.sql.Time object.

returns: the attribute; if the value is SQL NULL, returns null - java.sql.Time

throws: java.sql.SQLException - if a database access error occurs

read-timestamp clj

(read-timestamp this)

Reads the next attribute in the stream and returns it as a java.sql.Timestamp object.

returns: the attribute; if the value is SQL NULL, returns null - java.sql.Timestamp

throws: java.sql.SQLException - if a database access error occurs

read-url clj

(read-url this)

Reads an SQL DATALINK value from the stream and returns it as a java.net.URL object in the Java programming language.

returns: a java.net.URL object. - java.net.URL

throws: java.sql.SQLException - if a database access error occurs, or if a URL is malformed

was-null clj

(was-null this)

Retrieves whether the last value read was SQL NULL.

returns: true if the most recently read SQL value was SQL NULL; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs