public interface java.sql
SQLInput


Show All Login
Java SE 6
  
Implemented by: SQLInputImpl
Details
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.
since1.2


Methods
public Array readArray() throws SQLException Details
Reads an SQL ARRAY value from the stream and returns it as an Array object in the Java programming language.
returnan Array object representing data of the SQL ARRAY value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public InputStream readAsciiStream() throws SQLException Details
Reads the next attribute in the stream and returns it as a stream of ASCII characters.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public BigDecimal readBigDecimal() throws SQLException Details
Reads the next attribute in the stream and returns it as a java.math.BigDecimal object in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public InputStream readBinaryStream() throws SQLException Details
Reads the next attribute in the stream and returns it as a stream of uninterpreted bytes.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Blob readBlob() throws SQLException Details
Reads an SQL BLOB value from the stream and returns it as a Blob object in the Java programming language.
returna Blob object representing data of the SQL BLOB value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public boolean readBoolean() throws SQLException Details
Reads the next attribute in the stream and returns it as a boolean in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns false
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public byte readByte() throws SQLException Details
Reads the next attribute in the stream and returns it as a byte in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public byte[] readBytes() throws SQLException Details
Reads the next attribute in the stream and returns it as an array of bytes in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Reader readCharacterStream() throws SQLException Details
Reads the next attribute in the stream and returns it as a stream of Unicode characters.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Clob readClob() throws SQLException Details
Reads an SQL CLOB value from the stream and returns it as a Clob object in the Java programming language.
returna Clob object representing data of the SQL CLOB value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Date readDate() throws SQLException Details
Reads the next attribute in the stream and returns it as a java.sql.Date object.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public double readDouble() throws SQLException Details
Reads the next attribute in the stream and returns it as a double in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public float readFloat() throws SQLException Details
Reads the next attribute in the stream and returns it as a float in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public int readInt() throws SQLException Details
Reads the next attribute in the stream and returns it as an int in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public long readLong() throws SQLException Details
Reads the next attribute in the stream and returns it as a long in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public NClob readNClob() throws SQLException Details
Reads an SQL NCLOB value from the stream and returns it as a NClob object in the Java programming language.
returna NClob object representing data of the SQL NCLOB value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.6
public String readNString() throws SQLException Details
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.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.6
public Object readObject() throws SQLException Details
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.
returnthe datum at the head of the stream as an Object in the Java programming language;null if the datum is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2

public Ref readRef() throws SQLException Details
Reads an SQL REF value from the stream and returns it as a Ref object in the Java programming language.
returna Ref object representing the SQL REF value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public RowId readRowId() throws SQLException Details
Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.
returna RowId object representing data of the SQL ROWID value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.6
public short readShort() throws SQLException Details
Reads the next attribute in the stream and returns it as a short in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns 0
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public SQLXML readSQLXML() throws SQLException Details
Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.
returna SQLXML object representing data of the SQL XML value at the head of the stream; null if the value read is SQL NULL
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.6
public String readString() throws SQLException Details
Reads the next attribute in the stream and returns it as a String in the Java programming language.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Time readTime() throws SQLException Details
Reads the next attribute in the stream and returns it as a java.sql.Time object.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public Timestamp readTimestamp() throws SQLException Details
Reads the next attribute in the stream and returns it as a java.sql.Timestamp object.
returnthe attribute; if the value is SQL NULL, returns null
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public URL readURL() throws SQLException Details
Reads an SQL DATALINK value from the stream and returns it as a java.net.URL object in the Java programming language.
returna java.net.URL object.
ThrowsSQLException: if a database access error occurs, or if a URL is malformed
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.4
public boolean wasNull() throws SQLException Details
Retrieves whether the last value read was SQL NULL.
returntrue if the most recently read SQL value was SQL NULL; false otherwise
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2