Интерфейс SQLInput

Все известные реализующие классы:: SQLInputImpl

public interface SQLInput

Поток ввода, содержащий поток значений, представляющих экземпляр SQL-структурированного типа или SQL-дискретного типа. Этот интерфейс, используемый только для пользовательского сопоставления, используется драйвером в фоновом режиме, и программист никогда напрямую не вызывает SQLInput методы. Методы чтения (readLong, readBytes, и т. д.) предоставляют способ для реализации интерфейса SQLData читать значения в объекте SQLInput. И как описано в SQLData, вызовы методов чтения должны выполняться в порядке, в котором соответствующие атрибуты появляются в SQL-определении типа. Метод wasNull используется для определения, было ли последнее прочитанное значение SQL NULL.

Когда метод getObject вызывается с объектом класса, реализующего интерфейс SQLData, JDBC-драйвер вызывает метод SQLData.getSQLType для определения SQL-типа пользовательского типа (UDT), который пользовательски сопоставляется. Драйвер создает экземпляр SQLInput, заполняя его атрибутами UDT. Затем драйвер передает поток ввода методу SQLData.readSQL, который в свою очередь вызывает методы чтения SQLInput в своей реализации для чтения атрибутов из потока ввода.

С момента:: 1.2

Методы

Модификатор и тип	Метод	Описание
`Array`	`readArray()`	Читает значение SQL `ARRAY` из потока и возвращает его как объект `Array` на языке Java.
`InputStream`	`readAsciiStream()`	Читает следующий атрибут в потоке и возвращает его как поток ASCII-символов.
`BigDecimal`	`readBigDecimal()`	Читает следующий атрибут в потоке и возвращает его как объект `java.math.BigDecimal` на языке Java.
`InputStream`	`readBinaryStream()`	Читает следующий атрибут в потоке и возвращает его как поток неинтерпретированных байтов.
`Blob`	`readBlob()`	Читает значение SQL `BLOB` из потока и возвращает его как объект `Blob` на языке Java.
`boolean`	`readBoolean()`	Читает следующий атрибут в потоке и возвращает его как `boolean` на языке Java.
`byte`	`readByte()`	Читает следующий атрибут в потоке и возвращает его как `byte` на языке Java.
`byte[]`	`readBytes()`	Читает следующий атрибут в потоке и возвращает его как массив байтов на языке Java.
`Reader`	`readCharacterStream()`	Читает следующий атрибут в потоке и возвращает его как поток символов Юникода.
`Clob`	`readClob()`	Читает значение SQL `CLOB` из потока и возвращает его как объект `Clob` на языке Java.
`Date`	`readDate()`	Читает следующий атрибут в потоке и возвращает его как объект `java.sql.Date`.
`double`	`readDouble()`	Читает следующий атрибут в потоке и возвращает его как `double` на языке Java.
`float`	`readFloat()`	Читает следующий атрибут в потоке и возвращает его как `float` на языке Java.
`int`	`readInt()`	Читает следующий атрибут в потоке и возвращает его как `int` на языке Java.
`long`	`readLong()`	Читает следующий атрибут в потоке и возвращает его как `long` на языке Java.
`NClob`	`readNClob()`	Читает значение SQL `NCLOB` из потока и возвращает его как объект `NClob` на языке Java.
`String`	`readNString()`	Читает следующий атрибут в потоке и возвращает его как `String` на языке Java.
`Object`	`readObject()`	Читает данное в начале потока и возвращает его как `Object` на языке Java.
`default <T> T`	`readObject(Class<T> type)`	Читает следующий атрибут в потоке и возвращает его как `Object` на языке Java.
`Ref`	`readRef()`	Читает значение SQL `REF` из потока и возвращает его как объект `Ref` на языке Java.
`RowId`	`readRowId()`	Читает значение SQL `ROWID` из потока и возвращает его как объект `RowId` на языке Java.
`short`	`readShort()`	Читает следующий атрибут в потоке и возвращает его как `short` на языке Java.
`SQLXML`	`readSQLXML()`	Читает значение SQL `XML` из потока и возвращает его как объект `SQLXML` на языке Java.
`String`	`readString()`	Читает следующий атрибут в потоке и возвращает его как `String` на языке Java.
`Time`	`readTime()`	Читает следующий атрибут в потоке и возвращает его как объект `java.sql.Time`.
`Timestamp`	`readTimestamp()`	Читает следующий атрибут в потоке и возвращает его как объект `java.sql.Timestamp`.
`URL`	`readURL()`	Читает значение SQL `DATALINK` из потока и возвращает его как объект `java.net.URL` на языке Java.
`boolean`	`wasNull()`	Получает, было ли последнее прочитанное значение SQL `NULL`.

Методы

readString

String readString()
           throws SQLException

Считывает следующий атрибут в потоке и возвращает его как строку в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readBoolean

boolean readBoolean()
             throws SQLException

Считывает следующий атрибут в потоке и возвращает его как логическое значение в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает false
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readByte

byte readByte()
       throws SQLException

Считывает следующий атрибут в потоке и возвращает его как байт в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readShort

short readShort()
         throws SQLException

Считывает следующий атрибут в потоке и возвращает его как короткое целое число в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readInt

int readInt()
     throws SQLException

Считывает следующий атрибут в потоке и возвращает его как целое число в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readLong

long readLong()
       throws SQLException

Считывает следующий атрибут в потоке и возвращает его как длинное целое число в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readFloat

float readFloat()
         throws SQLException

Считывает следующий атрибут в потоке и возвращает его как число с плавающей точкой в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readDouble

double readDouble()
           throws SQLException

Считывает следующий атрибут в потоке и возвращает его как двойное число с плавающей точкой в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает 0
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readBigDecimal

BigDecimal readBigDecimal()
                   throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект BigDecimal в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readBytes

byte[] readBytes()
          throws SQLException

Считывает следующий атрибут в потоке и возвращает его как массив байтов в языке программирования Java.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readDate

Date readDate()
       throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект Date.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readTime

Time readTime()
       throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект Time.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readTimestamp

Timestamp readTimestamp()
                 throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект Timestamp.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readCharacterStream

Reader readCharacterStream()
                    throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток Unicode-символов.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readAsciiStream

InputStream readAsciiStream()
                     throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток ASCII-символов.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readBinaryStream

InputStream readBinaryStream()
                      throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток неинтерпретированных байтов.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readObject

Object readObject()
           throws SQLException

Считывает элемент данных в начале потока и возвращает его как объект в языке программирования Java. Фактический тип возвращаемого объекта определяется по умолчанию, а также любыми настройками, присутствующими в карте типов данного потока.

Карта типов регистрируется драйвером JDBC перед передачей потока приложению.

Когда элемент данных в начале потока является SQL NULL, метод возвращает null. Если элемент данных является структурированным или отличительным типом SQL, он определяет тип SQL элемента данных в начале потока. Если в карте типов потока есть запись для этого типа SQL, драйвер создает объект соответствующего класса и вызывает метод SQLData.readSQL на этом объекте, который считывает дополнительные данные из потока, используя протокол, описанный для этого метода.

Возвращает:: элемент данных в начале потока как объект в языке программирования Java; null если элемент данных является SQL NULL
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readRef

Ref readRef()
     throws SQLException

Считывает значение SQL REF из потока и возвращает его как объект Ref в языке программирования Java.

Возвращает:: объект Ref, представляющий значение SQL REF в начале потока; null если считанное значение является SQL NULL
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readBlob

Blob readBlob()
       throws SQLException

Считывает значение SQL BLOB из потока и возвращает его как объект Blob в языке программирования Java.

Возвращает:: объект Blob, представляющий данные значения SQL BLOB в начале потока; null если считанное значение является SQL NULL
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readClob

Clob readClob()
       throws SQLException

Считывает значение SQL CLOB из потока и возвращает его как объект Clob в языке программирования Java.

Возвращает:: объект Clob, представляющий данные значения SQL CLOB в начале потока; null если считанное значение является SQL NULL
Исключения:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

readArray

Array readArray()
         throws SQLException

Считывает значение SQL ARRAY из потока и возвращает его как объект Array на языке программирования Java.

Возвращает:: объект Array , представляющий данные значения SQL ARRAY в начале потока; null если считанное значение является SQL NULL
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.2

wasNull

boolean wasNull()
         throws SQLException

Получает, было ли последнее считанное значение SQL NULL.

Возвращает:: true , если последнее считанное значение SQL было SQL NULL; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.2

readURL

URL readURL()
     throws SQLException

Считывает значение SQL DATALINK из потока и возвращает его как объект java.net.URL на языке программирования Java.

Возвращает:: объект java.net.URL.
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных или URL имеет неправильный формат; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.4

readNClob

NClob readNClob()
         throws SQLException

Считывает значение SQL NCLOB из потока и возвращает его как объект NClob на языке программирования Java.

Возвращает:: объект NClob , представляющий данные значения SQL NCLOB в начале потока; null если считанное значение является SQL NULL
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.6

readNString

String readNString()
            throws SQLException

Считывает следующий атрибут в потоке и возвращает его как String на языке программирования Java. Предназначен для доступа к столбцам NCHAR, NVARCHAR и LONGNVARCHAR.

Возвращает:: атрибут; если значение является SQL NULL, возвращает null
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.6

readSQLXML

SQLXML readSQLXML()
           throws SQLException

Считывает значение SQL XML из потока и возвращает его как объект SQLXML на языке программирования Java.

Возвращает:: объект SQLXML , представляющий данные значения SQL XML в начале потока; null если считанное значение является SQL NULL
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.6

readRowId

RowId readRowId()
         throws SQLException

Считывает значение SQL ROWID из потока и возвращает его как объект RowId на языке программирования Java.

Возвращает:: объект RowId , представляющий данные значения SQL ROWID в начале потока; null если считанное значение является SQL NULL
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.6

readObject

default <T> T readObject(Class<T> type)
                  throws SQLException

Считывает следующий атрибут в потоке и возвращает его как Object на языке программирования Java. Фактический тип возвращаемого объекта определяется указанным типом данных Java и любыми пользовательскими настройками в карте типов этого потока.

Карта типов регистрируется JDBC-драйвером перед передачей потока приложению.

Когда атрибут в начале потока является SQL NULL метод возвращает null. Если атрибут имеет структурированный или отличительный тип SQL, он определяет тип SQL атрибута в начале потока. Если в карте типов потока есть запись для этого типа SQL, драйвер создает объект соответствующего класса и вызывает метод SQLData.readSQL на этом объекте, который считывает дополнительные данные из потока, используя протокол, описанный для этого метода.

По умолчанию реализация вызовет SQLFeatureNotSupportedException

Параметры типа:: T - тип класса, моделируемого этим объектом Class
Параметры:: type - класс, представляющий тип данных Java для преобразования атрибута.
Возвращает:: атрибут в начале потока как Object на языке программирования Java; null если атрибут является SQL NULL
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.8

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.sql/java/sql/SQLInput.html