diff options
Diffstat (limited to 'libjava/java/sql/SQLInput.java')
-rw-r--r-- | libjava/java/sql/SQLInput.java | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/libjava/java/sql/SQLInput.java b/libjava/java/sql/SQLInput.java new file mode 100644 index 0000000..2f9fd07 --- /dev/null +++ b/libjava/java/sql/SQLInput.java @@ -0,0 +1,332 @@ +/* SQLInput.java -- Read SQL values from a stream + Copyright (C) 1999, 2000 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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ + + +package java.sql; + +import java.io.InputStream; +import java.io.Reader; +import java.math.BigDecimal; + +/** + * 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. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + */ +public interface SQLInput +{ + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>String</code>. + * + * @return The value read from the stream as a <code>String</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract String +readString() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>boolean</code>. + * + * @return The value read from the stream as a <code>boolean</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract boolean +readBoolean() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>byte</code>. + * + * @return The value read from the stream as a <code>byte</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract byte +readByte() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>short</code>. + * + * @return The value read from the stream as a <code>short</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract short +readShort() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>int</code>. + * + * @return The value read from the stream as an <code>int</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract int +readInt() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>long</code>. + * + * @return The value read from the stream as a <code>long</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract long +readLong() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>float</code>. + * + * @return The value read from the stream as a <code>float</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract float +readFloat() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>double</code>. + * + * @return The value read from the stream as a <code>double</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract double +readDouble() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>BigDecimal</code>. + * + * @return The value read from the stream as a <code>BigDecimal</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract BigDecimal +readBigDecimal() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * byte array + * + * @return The value read from the stream as a byte array. + * + * @exception SQLException If an error occurs. + */ +public abstract byte[] +readBytes() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>java.sql.Date</code>. + * + * @return The value read from the stream as a <code>java.sql.Date</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract java.sql.Date +readDate() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>java.sql.Time</code>. + * + * @return The value read from the stream as a <code>java.sql.Time</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract java.sql.Time +readTime() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>java.sql.Timestamp</code>. + * + * @return The value read from the stream as a <code>java.sql.Timestamp</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract java.sql.Timestamp +readTimestamp() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a ASCII text + * <code>InputStream</code>. + * + * @return The value read from the stream as an <code>InputStream</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract InputStream +readAsciiStream() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a binary + * <code>InputStream</code>. + * + * @return The value read from the stream as an <code>InputStream</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract InputStream +readBinaryStream() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a character + * <code>Reader</code>. + * + * @return The value read from the stream as a <code>Reader</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Reader +readCharacterStream() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java + * <code>Object</code>. + * + * @return The value read from the stream as an <code>Object</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Object +readObject() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java SQL + * <code>Ref</code>. + * + * @return The value read from the stream as an <code>Ref</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Ref +readRef() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java SQL + * <code>Blob</code>. + * + * @return The value read from the stream as a <code>Blob</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Blob +readBlob() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java SQL + * <code>Clob</code>. + * + * @return The value read from the stream as a <code>Clob</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Clob +readClob() throws SQLException; + +/*************************************************************************/ + +/** + * This method reads the next item from the stream a Java SQL + * <code>Array</code>. + * + * @return The value read from the stream as an <code>Array</code>. + * + * @exception SQLException If an error occurs. + */ +public abstract Array +readArray() throws SQLException; + +/*************************************************************************/ + +/** + * This method tests whether or not the last value read was a SQL + * NULL value. + * + * @return <code>true</code> if the last value read was a NULL, + * <code>false</code> otherwise. + * + * @exception SQLException If an error occurs. + */ +public abstract boolean +wasNull() throws SQLException; + +} // interface SQLInput + |