```
public interface SQLInput
```
The SQLInput interface defines operations which apply to a type of input stream which carries a series of values representing an instance of an SQL structured type or SQL distinct type.
This interface is used to define custom mappings of SQL User Defined Types (UDTs) to Java classes. It is used by JDBC drivers, therefore application programmers do not normally use the SQLInput methods directly. Reader methods such as readLong and readBytes provide means to read values from an SQLInput stream.
When the getObject method is called with an object which implements the SQLData interface, the JDBC driver determines the SQL type of the UDT being mapped by calling the SQLData.getSQLType method. The driver creates an instance of an SQLInput stream, filling the stream with the attributes of the UDT. The SQLInput stream is passed to the SQLData.readSQL method which then calls the SQLInput reader methods to read the attributes.

See Also:

SQLData

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Array`	`readArray()`	Returns the next attribute in the stream in the form of a `java.sql.Array`.
`InputStream`	`readAsciiStream()`	Returns the next attribute in the stream in the form of an ASCII character stream embodied as a `java.io.InputStream`.
`BigDecimal`	`readBigDecimal()`	Returns the next attribute in the stream in the form of a `java.math.BigDecimal`.
`InputStream`	`readBinaryStream()`	Returns the next attribute in the stream in the form of a stream of bytes embodied as a `java.io.InputStream`.
`Blob`	`readBlob()`	Returns the next attribute in the stream in the form of a `java.sql.Blob`.
`boolean`	`readBoolean()`	Returns the next attribute in the stream in the form of a `boolean` .
`byte`	`readByte()`	Returns the next attribute in the stream in the form of a `byte`.
`byte[]`	`readBytes()`	Returns the next attribute in the stream in the form of a byte array.
`Reader`	`readCharacterStream()`	Returns the next attribute in the stream in the form of a Unicode character stream embodied as a `java.io.Reader`.
`Clob`	`readClob()`	Returns the next attribute in the stream in the form of a `java.sql.Clob`.
`Date`	`readDate()`	Returns the next attribute in the stream in the form of a `java.sql.Date`.
`double`	`readDouble()`	Returns the next attribute in the stream in the form of a `double`.
`float`	`readFloat()`	Returns the next attribute in the stream in the form of a `float`.
`int`	`readInt()`	Returns the next attribute in the stream in the form of an `int`.
`long`	`readLong()`	Returns the next attribute in the stream in the form of a `long`.
`NClob`	`readNClob()`	Returns the next attribute in the stream in the form of a `java.sql.NClob`.
`String`	`readNString()`	Returns the next attribute in the stream in the form of a `java.lang.String`.
`Object`	`readObject()`	Returns the next attribute in the stream in the form of a `java.lang.Object`.
`Ref`	`readRef()`	Returns the next attribute in the stream in the form of a `java.sql.Ref`.
`RowId`	`readRowId()`	Returns the next attribute in the stream in the form of a `java.sql.RowId`.
`short`	`readShort()`	Returns the next attribute in the stream in the form of a `short`.
`SQLXML`	`readSQLXML()`	Returns the next attribute in the stream in the form of a `java.sql.SQLXML`.
`String`	`readString()`	Returns the next attribute in the stream in the form of a `String`.
`Time`	`readTime()`	Returns the next attribute in the stream in the form of a `java.sql.Time`.
`Timestamp`	`readTimestamp()`	Returns the next attribute in the stream in the form of a `java.sql.Timestamp`.
`URL`	`readURL()`	Reads the next attribute in the stream (SQL DATALINK value) and returns it as a `java.net.URL` object.
`boolean`	`wasNull()`	Reports whether the last value read was SQL `NULL`.

- Method Detail
  - readString
```
String readString()
           throws SQLException
```
    Returns the next attribute in the stream in the form of a String.
    
    Returns:
    
    the next attribute. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readBoolean
```
boolean readBoolean()
             throws SQLException
```
    Returns the next attribute in the stream in the form of a boolean .
    
    Returns:
    
    the next attribute as a boolean. false if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readByte
```
byte readByte()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a byte.
    
    Returns:
    
    the next attribute as a byte. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readShort
```
short readShort()
         throws SQLException
```
    Returns the next attribute in the stream in the form of a short.
    
    Returns:
    
    the next attribute as a short. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readInt
```
int readInt()
     throws SQLException
```
    Returns the next attribute in the stream in the form of an int.
    
    Returns:
    
    the next attribute as an int. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readLong
```
long readLong()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a long.
    
    Returns:
    
    the next attribute as a long. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readFloat
```
float readFloat()
         throws SQLException
```
    Returns the next attribute in the stream in the form of a float.
    
    Returns:
    
    the next attribute as a float. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readDouble
```
double readDouble()
           throws SQLException
```
    Returns the next attribute in the stream in the form of a double.
    
    Returns:
    
    the next attribute as a double. 0 if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readBigDecimal
```
BigDecimal readBigDecimal()
                   throws SQLException
```
    Returns the next attribute in the stream in the form of a java.math.BigDecimal.
    
    Returns:
    
    the attribute as a java.math.BigDecimal. null if the read returns SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    BigDecimal
  - readBytes
```
byte[] readBytes()
          throws SQLException
```
    Returns the next attribute in the stream in the form of a byte array.
    
    Returns:
    
    the attribute as a byte array. null if the read returns SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readDate
```
Date readDate()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Date.
    
    Returns:
    
    the next attribute as a java.sql.Date. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Date
  - readTime
```
Time readTime()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Time.
    
    Returns:
    
    the attribute as a java.sql.Time. null if the read returns SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Time
  - readTimestamp
```
Timestamp readTimestamp()
                 throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Timestamp.
    
    Returns:
    
    the attribute as a java.sql.Timestamp. null if the read returns SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Timestamp
  - readCharacterStream
```
Reader readCharacterStream()
                    throws SQLException
```
    Returns the next attribute in the stream in the form of a Unicode character stream embodied as a java.io.Reader.
    
    Returns:
    
    the next attribute as a java.io.Reader. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Reader
  - readAsciiStream
```
InputStream readAsciiStream()
                     throws SQLException
```
    Returns the next attribute in the stream in the form of an ASCII character stream embodied as a java.io.InputStream.
    
    Returns:
    
    the next attribute as a java.io.InputStream. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    InputStream
  - readBinaryStream
```
InputStream readBinaryStream()
                      throws SQLException
```
    Returns the next attribute in the stream in the form of a stream of bytes embodied as a java.io.InputStream.
    
    Returns:
    
    the next attribute as a java.io.InputStream. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    InputStream
  - readObject
```
Object readObject()
           throws SQLException
```
    Returns the next attribute in the stream in the form of a java.lang.Object.
    The type of the Object returned is determined by the type mapping for this JDBC driver, including any customized mappings, if present. A type map is given to the SQLInput by the JDBC driver before the SQLInput is given to the application.
    If the attribute is an SQL structured or distinct type, its SQL type is determined. If the stream's type map contains an element for that SQL type, the driver creates an object for the relevant type and invokes the method SQLData.readSQL on it, which reads supplementary data from the stream using whichever protocol is defined for that method.
    
    Returns:
    
    the next attribute as an Object. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readRef
```
Ref readRef()
     throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Ref.
    
    Returns:
    
    the next attribute as a java.sql.Ref. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Ref
  - readBlob
```
Blob readBlob()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Blob.
    
    Returns:
    
    the next attribute as a java.sql.Blob. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readClob
```
Clob readClob()
       throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Clob.
    
    Returns:
    
    the next attribute as a java.sql.Clob. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Clob
  - readArray
```
Array readArray()
         throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.Array.
    
    Returns:
    
    the next attribute as an Array. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    Array
  - wasNull
```
boolean wasNull()
         throws SQLException
```
    Reports whether the last value read was SQL NULL.
    
    Returns:
    
    true if the last value read was SQL NULL, false otherwise.
    
    Throws:
    
    SQLException - if there is a database error.
  - readURL
```
URL readURL()
     throws SQLException
```
    Reads the next attribute in the stream (SQL DATALINK value) and returns it as a java.net.URL object.
    
    Returns:
    
    the next attribute as a java.net.URL. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
    
    See Also:
    
    URL
  - readNClob
```
NClob readNClob()
         throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.NClob.
    
    Returns:
    
    the next attribute as a java.sql.NClob. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readNString
```
String readNString()
            throws SQLException
```
    Returns the next attribute in the stream in the form of a java.lang.String. Used for the NCHAR, NVARCHAR and LONGNVARCHAR types. See readString() otherwise.
    
    Returns:
    
    the next attribute as a java.lang.String. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readSQLXML
```
SQLXML readSQLXML()
           throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.SQLXML.
    
    Returns:
    
    the next attribute as a java.sql.SQLXML. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.
  - readRowId
```
RowId readRowId()
         throws SQLException
```
    Returns the next attribute in the stream in the form of a java.sql.RowId. Used for the ROWID type.
    
    Returns:
    
    the next attribute as a java.sql.RowId. null if the value is SQL NULL.
    
    Throws:
    
    SQLException - if there is a database error.

Interface SQLInput

Method Summary

Method Detail

readString

readBoolean

readByte

readShort

readInt

readLong

readFloat

readDouble

readBigDecimal

readBytes

readDate

readTime

readTimestamp

readCharacterStream

readAsciiStream

readBinaryStream

readObject

readRef

readBlob

readClob

readArray

wasNull

readURL

readNClob

readNString

readSQLXML

readRowId