Skip to content

Most visited

Recently visited

navigation
Added in API level 1

SQLInput

public interface SQLInput

java.sql.SQLInput


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.

Summary

Public methods

abstract Array readArray()

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

abstract InputStream readAsciiStream()

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

abstract BigDecimal readBigDecimal()

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

abstract InputStream readBinaryStream()

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

abstract Blob readBlob()

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

abstract boolean readBoolean()

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

abstract byte readByte()

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

abstract byte[] readBytes()

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

abstract Reader readCharacterStream()

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

abstract Clob readClob()

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

abstract Date readDate()

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

abstract double readDouble()

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

abstract float readFloat()

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

abstract int readInt()

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

abstract long readLong()

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

abstract NClob readNClob()

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

abstract String readNString()

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

abstract Object readObject()

Reads the datum at the head of the stream and returns it as an Object in the Java programming language.

abstract Ref readRef()

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

abstract RowId readRowId()

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

abstract SQLXML readSQLXML()

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

abstract short readShort()

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

abstract String readString()

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

abstract Time readTime()

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

abstract Timestamp readTimestamp()

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

abstract URL readURL()

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

abstract boolean wasNull()

Retrieves whether the last value read was SQL NULL.

Public methods

readArray

Added in API level 1
Array readArray ()

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

Returns
Array an Array object representing data of the SQL ARRAY value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readAsciiStream

Added in API level 1
InputStream readAsciiStream ()

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

Returns
InputStream the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readBigDecimal

Added in API level 1
BigDecimal readBigDecimal ()

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

Returns
BigDecimal the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readBinaryStream

Added in API level 1
InputStream readBinaryStream ()

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

Returns
InputStream the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readBlob

Added in API level 1
Blob readBlob ()

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

Returns
Blob a Blob object representing data of the SQL BLOB value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readBoolean

Added in API level 1
boolean readBoolean ()

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

Returns
boolean the attribute; if the value is SQL NULL, returns false
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readByte

Added in API level 1
byte readByte ()

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

Returns
byte the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readBytes

Added in API level 1
byte[] readBytes ()

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

Returns
byte[] the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readCharacterStream

Added in API level 1
Reader readCharacterStream ()

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

Returns
Reader the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readClob

Added in API level 1
Clob readClob ()

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

Returns
Clob a Clob object representing data of the SQL CLOB value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readDate

Added in API level 1
Date readDate ()

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

Returns
Date the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readDouble

Added in API level 1
double readDouble ()

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

Returns
double the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readFloat

Added in API level 1
float readFloat ()

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

Returns
float the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readInt

Added in API level 1
int readInt ()

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

Returns
int the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readLong

Added in API level 1
long readLong ()

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

Returns
long the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readNClob

Added in API level 9
NClob readNClob ()

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

Returns
NClob a NClob object representing data of the SQL NCLOB value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readNString

Added in API level 9
String readNString ()

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
String the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readObject

Added in API level 1
Object readObject ()

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.

Returns
Object the datum at the head of the stream as an Object in the Java programming language;null if the datum is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readRef

Added in API level 1
Ref readRef ()

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

Returns
Ref a Ref object representing the SQL REF value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readRowId

Added in API level 9
RowId readRowId ()

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

Returns
RowId a RowId object representing data of the SQL ROWID value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readSQLXML

Added in API level 9
SQLXML readSQLXML ()

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

Returns
SQLXML a SQLXML object representing data of the SQL XML value at the head of the stream; null if the value read is SQL NULL
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readShort

Added in API level 1
short readShort ()

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

Returns
short the attribute; if the value is SQL NULL, returns 0
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readString

Added in API level 1
String readString ()

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

Returns
String the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readTime

Added in API level 1
Time readTime ()

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

Returns
Time the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readTimestamp

Added in API level 1
Timestamp readTimestamp ()

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

Returns
Timestamp the attribute; if the value is SQL NULL, returns null
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

readURL

Added in API level 1
URL readURL ()

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

Returns
URL a java.net.URL object.
Throws
SQLException if a database access error occurs, or if a URL is malformed
SQLFeatureNotSupportedException if the JDBC driver does not support this method

wasNull

Added in API level 1
boolean wasNull ()

Retrieves whether the last value read was SQL NULL.

Returns
boolean true if the most recently read SQL value was SQL NULL; false otherwise
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.