java.sql.SQLInput |
Known Indirect Subclasses |
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.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Reads an SQL
ARRAY value from the stream and returns it as an
Array object 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 a
java.math.BigDecimal
object in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a stream of uninterpreted
bytes.
| |||||||||||
Reads an SQL
BLOB value from the stream and returns it as a
Blob object in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
boolean
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
byte
in the Java programming language. | |||||||||||
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.
| |||||||||||
Reads an SQL
CLOB value from the stream and returns it as a
Clob object in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
java.sql.Date object. | |||||||||||
Reads the next attribute in the stream and returns it as a
double
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
float
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as an
int
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
long
in the Java programming language. | |||||||||||
Reads an SQL
NCLOB value from the stream and returns it as a
NClob object in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
String
in the Java programming language. | |||||||||||
Reads the datum at the head of the stream and returns it as an
Object in the Java programming language. | |||||||||||
Reads an SQL
REF value from the stream and returns it as a
Ref object in the Java programming language. | |||||||||||
Reads an SQL
ROWID value from the stream and returns it as a
RowId object in the Java programming language. | |||||||||||
Reads an SQL
XML value from the stream and returns it as a
SQLXML object in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
short
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
String
in the Java programming language. | |||||||||||
Reads the next attribute in the stream and returns it as a
java.sql.Time object. | |||||||||||
Reads the next attribute in the stream and returns it as a
java.sql.Timestamp object. | |||||||||||
Reads an SQL
DATALINK value from the stream and returns it as a
java.net.URL object in the Java programming language. | |||||||||||
Retrieves whether the last value read was SQL
NULL . |
Reads an SQL ARRAY
value from the stream and returns it as an
Array
object in the Java programming language.
Array
object representing data of the SQL
ARRAY
value at the head of the stream; null
if the value read is SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a stream of ASCII characters.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a java.math.BigDecimal
object in the Java programming language.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a stream of uninterpreted bytes.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL BLOB
value from the stream and returns it as a
Blob
object in the Java programming language.
Blob
object representing data of the SQL BLOB
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a boolean
in the Java programming language.
NULL
, returns false
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a byte
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as an array of bytes in the Java programming language.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a stream of Unicode characters.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL CLOB
value from the stream and returns it as a
Clob
object in the Java programming language.
Clob
object representing data of the SQL CLOB
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a java.sql.Date
object.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a double
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a float
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as an int
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a long
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL NCLOB
value from the stream and returns it as a
NClob
object in the Java programming language.
NClob
object representing data of the SQL NCLOB
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
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.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the datum at the head of the stream and returns it as an
Object
in 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 returns null
. 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 method
SQLData.readSQL
on that object, which reads additional data from the
stream, using the protocol described for that method.
Object
in the
Java programming language;null
if the datum is SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL REF
value from the stream and returns it as a
Ref
object in the Java programming language.
Ref
object representing the SQL REF
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL ROWID
value from the stream and returns it as a
RowId
object in the Java programming language.
RowId
object representing data of the SQL ROWID
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL XML
value from the stream and returns it as a
SQLXML
object in the Java programming language.
SQLXML
object representing data of the SQL XML
value
at the head of the stream; null
if the value read is
SQL NULL
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a short
in the Java programming language.
NULL
, returns 0
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a String
in the Java programming language.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a java.sql.Time
object.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads the next attribute in the stream and returns it as a java.sql.Timestamp
object.
NULL
, returns null
SQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Reads an SQL DATALINK
value from the stream and returns it as a
java.net.URL
object in the Java programming language.
java.net.URL
object.SQLException | if a database access error occurs, or if a URL is malformed |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
Retrieves whether the last value read was SQL NULL
.
true
if the most recently read SQL value was SQL
NULL
; false
otherwiseSQLException | if a database access error occurs |
---|---|
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |