Spec-Zone.ru › OpenJDK 24

Класс SQLInputImpl

java.lang.Object
javax.sql.rowset.serial.SQLInputImpl
Все реализуемые интерфейсы:
SQLInput
public class SQLInputImpl extends Object implements SQLInput
Поток ввода, используемый для пользовательского сопоставления типов данных (UDT). Объект SQLInputImpl представляет собой поток ввода, содержащий поток значений, которые являются атрибутами UDT.

Этот класс используется драйвером за кулисами, когда вызывается метод getObject для SQL-структурированного или раздельного типа с пользовательским сопоставлением; программист никогда напрямую не вызывает методы SQLInputImpl. Они предоставляются для удобства разработчиков, создающих реализации RowSet.

Класс SQLInputImpl предоставляет набор методов чтения, аналогичных методам ResultSet. Эти методы позволяют читать значения в объекте SQLInputImpl.

Метод wasNull используется для определения, было ли последнее прочитанное значение SQL NULL.

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

С тех пор:
1.5
См. также:
  • SQLData

Краткое описание конструкторов

Конструктор Описание
SQLInputImpl(Object[] attributes, Map<String,Class<?>> map)
Создаёт объект SQLInputImpl, инициализированный заданным массивом атрибутов и заданной картой типов.

Краткое описание методов

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

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Методы, объявленные в интерфейсе java.sql.SQLInput

readObject

Подробное описание конструкторов

SQLInputImpl

public SQLInputImpl(Object[] attributes, Map<String,Class<?>> map) throws SQLException
Создаёт объект SQLInputImpl, инициализированный заданным массивом атрибутов и заданной картой типов. Если какой-либо из атрибутов является типом UDT, чьё имя присутствует в записи карты типов, этот атрибут будет сопоставлен соответствующей реализации SQLData.
Параметры:
attributes - массив экземпляров Object, где каждый элемент является атрибутом типа UDT. Порядок атрибутов в массиве соответствует порядку их определения в определении типа UDT.
map - объект java.util.Map, содержащий ноль или более записей, каждая из которых состоит из 1) String, указывающего полное имя типа UDT, и 2) объекта Class для реализации сопоставления SQLData, определяющего, как должен быть сопоставлен тип UDT
Исключения:
SQLException - если attributes или map имеют значение null

Подробное описание методов

readString

public String readString() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как строку в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readString в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке нет дополнительных значений.

readBoolean

public boolean readBoolean() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как логическое значение в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readBoolean в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке нет дополнительных значений.

readByte

public byte readByte() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как байт в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readByte в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке нет дополнительных значений

readShort

public short readShort() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как целое число со знаком в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readShort в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readInt

public int readInt() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как целое число в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readInt в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readLong

public long readLong() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как длинное целое число в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readLong в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readFloat

public float readFloat() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как число с плавающей точкой в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readFloat в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readDouble

public double readDouble() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как двойное число с плавающей точкой в языке программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readDouble в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readBigDecimal

public BigDecimal readBigDecimal() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как объект BigDecimal.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readBigDecimal в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readBytes

public byte[] readBytes() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как массив байтов.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована реализации сопоставления UDT, определённой объектом SQLData.

Определено в:
readBytes в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Исключения:
SQLException - если позиция чтения находится в недопустимой позиции или если больше нет значений в потоке

readDate

public Date readDate() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl в качестве объекта java.sql.Date.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом; эта ответственность делегирована отображению UDT, как определено реализацией SQLData.

Определено в:
readDate в интерфейсе SQLInput
Возвращает:
следующий атрибут в этом объекте SQLInputImpl; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений

readTime

public Time readTime() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как объект java.sql.Time.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readTime в интерфейсе SQLInput
Возвращает:
атрибут; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readTimestamp

public Timestamp readTimestamp() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как объект java.sql.Timestamp.
Определено в:
readTimestamp в интерфейсе SQLInput
Возвращает:
атрибут; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readCharacterStream

public Reader readCharacterStream() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как поток Unicode-символов.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readCharacterStream в интерфейсе SQLInput
Возвращает:
атрибут; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readAsciiStream

public InputStream readAsciiStream() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как поток ASCII-символов.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readAsciiStream в интерфейсе SQLInput
Возвращает:
атрибут; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readBinaryStream

public InputStream readBinaryStream() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl как поток неинтерпретированных байтов.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readBinaryStream в интерфейсе SQLInput
Возвращает:
атрибут; если значение является SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readObject

public Object readObject() throws SQLException
Возвращает значение в начале этого объекта SQLInputImpl как объект Object языка программирования Java. Фактический тип возвращаемого объекта определяется стандартным отображением типов SQL на типы языка программирования Java, если только нет пользовательского отображения, в таком случае тип возвращаемого объекта определяется картой типов этого потока.

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

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

Определено в:
readObject в интерфейсе SQLInput
Возвращает:
значение в начале потока как объект Object языка программирования Java; null если значение является SQL NULL
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readRef

public Ref readRef() throws SQLException
Возвращает значение в начале этого объекта SQLInputImpl как объект Ref языка программирования Java.
Определено в:
readRef в интерфейсе SQLInput
Возвращает:
объект Ref, представляющий значение SQL REF в начале потока; если значение равно SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readBlob

public Blob readBlob() throws SQLException
Возвращает значение BLOB в начале этого объекта SQLInputImpl как объект Blob языка программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readBlob в интерфейсе SQLInput
Возвращает:
объект Blob, представляющий значение SQL BLOB в начале этого потока; если значение равно SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readClob

public Clob readClob() throws SQLException
Возвращает значение CLOB в начале этого объекта SQLInputImpl как объект Clob языка программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readClob в интерфейсе SQLInput
Возвращает:
объект Clob, представляющий значение SQL CLOB в начале потока; если значение равно SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

readArray

public Array readArray() throws SQLException
Читает значение SQL ARRAY из потока и возвращает его как объект Array языка программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегирована отображению UDT, реализованному реализацией SQLData.

Определено в:
readArray в интерфейсе SQLInput
Возвращает:
объект Array, представляющий значение SQL ARRAY в начале потока; * если значение равно SQL NULL, возвращает null
Выбрасывает:
SQLException - если позиция чтения находится в недопустимой позиции или если в потоке больше нет значений.

wasNull

public boolean wasNull() throws SQLException
Определяет, было ли последнее прочитанное значение из этого объекта SQLInputImpl значением null.
Определено в:
wasNull в интерфейсе SQLInput
Возвращает:
true, если последнее прочитанное значение SQL было null; в противном случае, false; по умолчанию возвращает false
Выбрасывает:
SQLException - если произошла ошибка при определении, было ли последнее прочитанное значение значением null;

readURL

public URL readURL() throws SQLException
Считывает значение SQL DATALINK из потока и возвращает его в виде объекта URL языка программирования Java.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, поскольку эта ответственность делегируется отображению UDT, реализованному реализацией SQLData.

Определено в:
readURL в интерфейсе SQLInput
Возвращает:
объект URL, представляющий значение SQL DATALINK в начале потока; * если значение является SQL NULL, возвращает null
Бросает:
SQLException - если позиция чтения находится в недопустимой позиции; или если в потоке нет других значений.

readNClob

public NClob readNClob() throws SQLException
Считывает значение SQL NCLOB из потока и возвращает его как объект Clob языка программирования Java.
Определено в:
readNClob в интерфейсе SQLInput
Возвращает:
объект NClob, представляющий данные значения SQL NCLOB в начале потока; null если считанное значение — SQL NULL
Бросает:
SQLException - если произошла ошибка доступа к базе данных
С:
1.6

readNString

public String readNString() throws SQLException
Считывает следующий атрибут в потоке и возвращает его как String в языке программирования Java. Предназначено для доступа к NCHAR,NVARCHAR и LONGNVARCHAR столбцам.
Определено в:
readNString в интерфейсе SQLInput
Возвращает:
атрибут; если значение SQL NULL, возвращает null
Бросает:
SQLException - если произошла ошибка доступа к базе данных
С:
1.6

readSQLXML

public SQLXML readSQLXML() throws SQLException
Считывает значение SQL XML из потока и возвращает его как объект SQLXML языка программирования Java.
Определено в:
readSQLXML в интерфейсе SQLInput
Возвращает:
объект SQLXML, представляющий данные значения SQL XML в начале потока; null если считанное значение — SQL NULL
Бросает:
SQLException - если произошла ошибка доступа к базе данных
С:
1.6

readRowId

public RowId readRowId() throws SQLException
Считывает значение SQL ROWID из потока и возвращает его как объект RowId языка программирования Java.
Определено в:
readRowId в интерфейсе SQLInput
Возвращает:
объект RowId, представляющий данные значения SQL ROWID в начале потока; null если считанное значение — SQL NULL
Бросает:
SQLException - если произошла ошибка доступа к базе данных
С:
1.6

© 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://download.java.net/java/early_access/jdk24/docs/api/java.sql.rowset/javax/sql/rowset/serial/SQLInputImpl.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API