- All Known Implementing Classes:
SQLInputImpl
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.
- Since:
- 1.2
-
Method Summary
Modifier and TypeMethodDescriptionReads an SQLARRAYvalue from the stream and returns it as anArrayobject in the Java programming language.Reads the next attribute in the stream and returns it as a stream of ASCII characters.Reads the next attribute in the stream and returns it as ajava.math.BigDecimalobject in the Java programming language.Reads the next attribute in the stream and returns it as a stream of uninterpreted bytes.readBlob()Reads an SQLBLOBvalue from the stream and returns it as aBlobobject in the Java programming language.booleanReads the next attribute in the stream and returns it as abooleanin the Java programming language.bytereadByte()Reads the next attribute in the stream and returns it as abytein the Java programming language.byte[]Reads the next attribute in the stream and returns it as an array of bytes in the Java programming language.Reads the next attribute in the stream and returns it as a stream of Unicode characters.readClob()Reads an SQLCLOBvalue from the stream and returns it as aClobobject in the Java programming language.readDate()Reads the next attribute in the stream and returns it as ajava.sql.Dateobject.doubleReads the next attribute in the stream and returns it as adoublein the Java programming language.floatReads the next attribute in the stream and returns it as afloatin the Java programming language.intreadInt()Reads the next attribute in the stream and returns it as anintin the Java programming language.longreadLong()Reads the next attribute in the stream and returns it as alongin the Java programming language.Reads an SQLNCLOBvalue from the stream and returns it as aNClobobject in the Java programming language.Reads the next attribute in the stream and returns it as aStringin the Java programming language.Reads the datum at the head of the stream and returns it as anObjectin the Java programming language.default <T> TreadObject(Class<T> type) Reads the next attribute in the stream and returns it as anObjectin the Java programming language.readRef()Reads an SQLREFvalue from the stream and returns it as aRefobject in the Java programming language.Reads an SQLROWIDvalue from the stream and returns it as aRowIdobject in the Java programming language.shortReads the next attribute in the stream and returns it as ashortin the Java programming language.Reads an SQLXMLvalue from the stream and returns it as aSQLXMLobject in the Java programming language.Reads the next attribute in the stream and returns it as aStringin the Java programming language.readTime()Reads the next attribute in the stream and returns it as ajava.sql.Timeobject.Reads the next attribute in the stream and returns it as ajava.sql.Timestampobject.readURL()Reads an SQLDATALINKvalue from the stream and returns it as ajava.net.URLobject in the Java programming language.booleanwasNull()Retrieves whether the last value read was SQLNULL.
-
Method Details
-
readString
Reads the next attribute in the stream and returns it as aStringin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readBoolean
Reads the next attribute in the stream and returns it as abooleanin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returnsfalse - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readByte
Reads the next attribute in the stream and returns it as abytein the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readShort
Reads the next attribute in the stream and returns it as ashortin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readInt
Reads the next attribute in the stream and returns it as anintin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readLong
Reads the next attribute in the stream and returns it as alongin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readFloat
Reads the next attribute in the stream and returns it as afloatin the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readDouble
Reads the next attribute in the stream and returns it as adoublein the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returns0 - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readBigDecimal
Reads the next attribute in the stream and returns it as ajava.math.BigDecimalobject in the Java programming language.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readBytes
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, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readDate
Reads the next attribute in the stream and returns it as ajava.sql.Dateobject.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readTime
Reads the next attribute in the stream and returns it as ajava.sql.Timeobject.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readTimestamp
Reads the next attribute in the stream and returns it as ajava.sql.Timestampobject.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readCharacterStream
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, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readAsciiStream
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, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readBinaryStream
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, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readObject
Reads the datum at the head of the stream and returns it as anObjectin the Java programming language. The actual type of the object returned is determined by the default type mapping, 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 datum at the head of the stream is an SQL
NULL, the method returnsnull. If the datum is an SQL structured or distinct type, it determines the SQL type of the datum 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 methodSQLData.readSQLon that object, which reads additional data from the stream, using the protocol described for that method.- Returns:
- the datum at the head of the stream as an
Objectin the Java programming language;nullif the datum is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readRef
Reads an SQLREFvalue from the stream and returns it as aRefobject in the Java programming language.- Returns:
- a
Refobject representing the SQLREFvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readBlob
Reads an SQLBLOBvalue from the stream and returns it as aBlobobject in the Java programming language.- Returns:
- a
Blobobject representing data of the SQLBLOBvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readClob
Reads an SQLCLOBvalue from the stream and returns it as aClobobject in the Java programming language.- Returns:
- a
Clobobject representing data of the SQLCLOBvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readArray
Reads an SQLARRAYvalue from the stream and returns it as anArrayobject in the Java programming language.- Returns:
- an
Arrayobject representing data of the SQLARRAYvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
wasNull
Retrieves whether the last value read was SQLNULL.- Returns:
trueif the most recently read SQL value was SQLNULL;falseotherwise- Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
readURL
Reads an SQLDATALINKvalue from the stream and returns it as ajava.net.URLobject in the Java programming language.- Returns:
- a
java.net.URLobject. - Throws:
SQLException- if a database access error occurs, or if a URL is malformedSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
readNClob
Reads an SQLNCLOBvalue from the stream and returns it as aNClobobject in the Java programming language.- Returns:
- a
NClobobject representing data of the SQLNCLOBvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
readNString
Reads the next attribute in the stream and returns it as aStringin the Java programming language. It is intended for use when accessingNCHAR,NVARCHARandLONGNVARCHARcolumns.- Returns:
- the attribute; if the value is SQL
NULL, returnsnull - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
readSQLXML
Reads an SQLXMLvalue from the stream and returns it as aSQLXMLobject in the Java programming language.- Returns:
- a
SQLXMLobject representing data of the SQLXMLvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
readRowId
Reads an SQLROWIDvalue from the stream and returns it as aRowIdobject in the Java programming language.- Returns:
- a
RowIdobject representing data of the SQLROWIDvalue at the head of the stream;nullif the value read is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
readObject
Reads the next attribute in the stream and returns it as anObjectin 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
NULLthe method returnsnull. 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 methodSQLData.readSQLon that object, which reads additional data from the stream, using the protocol described for that method.The default implementation will throw
SQLFeatureNotSupportedException- Type Parameters:
T- the type of the class modeled by this Class object- Parameters:
type- Class representing the Java data type to convert the attribute to.- Returns:
- the attribute at the head of the stream as an
Objectin the Java programming language;nullif the attribute is SQLNULL - Throws:
SQLException- if a database access error occursSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.8
-