java.sql
Interface SQLInput


public interface SQLInput

This interface provides methods for reading values from a stream that is connected to a SQL structured or distinct type. It is used for custom mapping of user defined data types.


Method Summary
 Array readArray()
          This method reads the next item from the stream a Java SQL Array.
 InputStream readAsciiStream()
          This method reads the next item from the stream a ASCII text InputStream.
 BigDecimal readBigDecimal()
          This method reads the next item from the stream a Java BigDecimal.
 InputStream readBinaryStream()
          This method reads the next item from the stream a binary InputStream.
 Blob readBlob()
          This method reads the next item from the stream a Java SQL Blob.
 boolean readBoolean()
          This method reads the next item from the stream a Java boolean.
 byte readByte()
          This method reads the next item from the stream a Java byte.
 byte[] readBytes()
          This method reads the next item from the stream a Java byte array
 Reader readCharacterStream()
          This method reads the next item from the stream a character Reader.
 Clob readClob()
          This method reads the next item from the stream a Java SQL Clob.
 Date readDate()
          This method reads the next item from the stream a Java java.sql.Date.
 double readDouble()
          This method reads the next item from the stream a Java double.
 float readFloat()
          This method reads the next item from the stream a Java float.
 int readInt()
          This method reads the next item from the stream a Java int.
 long readLong()
          This method reads the next item from the stream a Java long.
 Object readObject()
          This method reads the next item from the stream a Java Object.
 Ref readRef()
          This method reads the next item from the stream a Java SQL Ref.
 short readShort()
          This method reads the next item from the stream a Java short.
 String readString()
          This method reads the next item from the stream a Java String.
 Time readTime()
          This method reads the next item from the stream a Java java.sql.Time.
 Timestamp readTimestamp()
          This method reads the next item from the stream a Java java.sql.Timestamp.
 URL readURL()
           
 boolean wasNull()
          This method tests whether or not the last value read was a SQL NULL value.
 

Method Detail

readString

String readString()
                  throws SQLException
This method reads the next item from the stream a Java String.

Returns:
The value read from the stream as a String.
Throws:
SQLException - If an error occurs.

readBoolean

boolean readBoolean()
                    throws SQLException
This method reads the next item from the stream a Java boolean.

Returns:
The value read from the stream as a boolean.
Throws:
SQLException - If an error occurs.

readByte

byte readByte()
              throws SQLException
This method reads the next item from the stream a Java byte.

Returns:
The value read from the stream as a byte.
Throws:
SQLException - If an error occurs.

readShort

short readShort()
                throws SQLException
This method reads the next item from the stream a Java short.

Returns:
The value read from the stream as a short.
Throws:
SQLException - If an error occurs.

readInt

int readInt()
            throws SQLException
This method reads the next item from the stream a Java int.

Returns:
The value read from the stream as an int.
Throws:
SQLException - If an error occurs.

readLong

long readLong()
              throws SQLException
This method reads the next item from the stream a Java long.

Returns:
The value read from the stream as a long.
Throws:
SQLException - If an error occurs.

readFloat

float readFloat()
                throws SQLException
This method reads the next item from the stream a Java float.

Returns:
The value read from the stream as a float.
Throws:
SQLException - If an error occurs.

readDouble

double readDouble()
                  throws SQLException
This method reads the next item from the stream a Java double.

Returns:
The value read from the stream as a double.
Throws:
SQLException - If an error occurs.

readBigDecimal

BigDecimal readBigDecimal()
                          throws SQLException
This method reads the next item from the stream a Java BigDecimal.

Returns:
The value read from the stream as a BigDecimal.
Throws:
SQLException - If an error occurs.

readBytes

byte[] readBytes()
                 throws SQLException
This method reads the next item from the stream a Java byte array

Returns:
The value read from the stream as a byte array.
Throws:
SQLException - If an error occurs.

readDate

Date readDate()
              throws SQLException
This method reads the next item from the stream a Java java.sql.Date.

Returns:
The value read from the stream as a java.sql.Date.
Throws:
SQLException - If an error occurs.

readTime

Time readTime()
              throws SQLException
This method reads the next item from the stream a Java java.sql.Time.

Returns:
The value read from the stream as a java.sql.Time.
Throws:
SQLException - If an error occurs.

readTimestamp

Timestamp readTimestamp()
                        throws SQLException
This method reads the next item from the stream a Java java.sql.Timestamp.

Returns:
The value read from the stream as a java.sql.Timestamp.
Throws:
SQLException - If an error occurs.

readCharacterStream

Reader readCharacterStream()
                           throws SQLException
This method reads the next item from the stream a character Reader.

Returns:
The value read from the stream as a Reader.
Throws:
SQLException - If an error occurs.

readAsciiStream

InputStream readAsciiStream()
                            throws SQLException
This method reads the next item from the stream a ASCII text InputStream.

Returns:
The value read from the stream as an InputStream.
Throws:
SQLException - If an error occurs.

readBinaryStream

InputStream readBinaryStream()
                             throws SQLException
This method reads the next item from the stream a binary InputStream.

Returns:
The value read from the stream as an InputStream.
Throws:
SQLException - If an error occurs.

readObject

Object readObject()
                  throws SQLException
This method reads the next item from the stream a Java Object.

Returns:
The value read from the stream as an Object.
Throws:
SQLException - If an error occurs.

readRef

Ref readRef()
            throws SQLException
This method reads the next item from the stream a Java SQL Ref.

Returns:
The value read from the stream as an Ref.
Throws:
SQLException - If an error occurs.

readBlob

Blob readBlob()
              throws SQLException
This method reads the next item from the stream a Java SQL Blob.

Returns:
The value read from the stream as a Blob.
Throws:
SQLException - If an error occurs.

readClob

Clob readClob()
              throws SQLException
This method reads the next item from the stream a Java SQL Clob.

Returns:
The value read from the stream as a Clob.
Throws:
SQLException - If an error occurs.

readArray

Array readArray()
                throws SQLException
This method reads the next item from the stream a Java SQL Array.

Returns:
The value read from the stream as an Array.
Throws:
SQLException - If an error occurs.

wasNull

boolean wasNull()
                throws SQLException
This method tests whether or not the last value read was a SQL NULL value.

Returns:
true if the last value read was a NULL, false otherwise.
Throws:
SQLException - If an error occurs.

readURL

URL readURL()
            throws SQLException
Throws:
SQLException
Since:
1.4