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 Details

readArray

public 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.

readAsciiStream

public 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.

readBigDecimal

public 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.

readBinaryStream

public 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.

readBlob

public 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.

readBoolean

public 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

public 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.

readBytes

public 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.

readCharacterStream

public 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.

readClob

public 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.

readDate

public 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.

readDouble

public 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.

readFloat

public 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.

readInt

public 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

public 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.

readObject

public 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

public 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.

readShort

public 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.

readString

public 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.

readTime

public 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

public 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.

readURL

public URL readURL()
            throws SQLException
Since:
1.4

wasNull

public 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.

SQLInput.java -- Read SQL values from a stream Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.