Интерфейс 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

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

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

readBoolean

boolean readBoolean() throws SQLException

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

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

readByte

byte readByte() throws SQLException

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

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

readShort

short readShort() throws SQLException

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

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

readInt

int readInt() throws SQLException

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

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

readLong

long readLong() throws SQLException

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

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

readFloat

float readFloat() throws SQLException

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

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

readDouble

double readDouble() throws SQLException

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

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

readBigDecimal

BigDecimal readBigDecimal() throws SQLException

Считывает следующий атрибут из потока и возвращает его как объект java.math.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

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

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

readTime

Time readTime() throws SQLException

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

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

readTimestamp

Timestamp readTimestamp() throws SQLException

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

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

readCharacterStream

Reader readCharacterStream() throws SQLException

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

Возвращает:: атрибут; если значение равно 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

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

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

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

Возвращает:: элемент в начале потока как Object в языке программирования 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, 2025, 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/25/docs/api/java.sql/java/sql/SQLInput.html