Интерфейс 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()`	Считывает следующий атрибут в потоке и возвращает его как поток символов Unicode.
`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.

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

readClob

Clob readClob() throws SQLException

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

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

readArray

Array readArray() throws SQLException

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

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

wasNull

boolean wasNull() throws SQLException

Возвращает значение, указывающее, было ли последнее прочитанное значение SQL NULL.

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

readURL

URL readURL() throws SQLException

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

Returns:: объект java.net.URL .
Throws:: SQLException - если произошла ошибка доступа к базе данных или URL некорректен; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
Since:: 1.4

readNClob

NClob readNClob() throws SQLException

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

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

readNString

String readNString() throws SQLException

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

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

readSQLXML

SQLXML readSQLXML() throws SQLException

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

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

readRowId

RowId readRowId() throws SQLException

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

Returns:: объект RowId , представляющий данные значения SQL ROWID в начале потока; null если считанное значение — SQL NULL
Throws:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
Since:: 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

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

© 1993, 2021, 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/17/docs/api/java.sql/java/sql/SQLInput.html