Spec-Zone.ru › OpenJDK 17

Класс 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 в качестве String языка программирования Java.

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

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

readBoolean

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

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

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

readByte

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

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

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

readShort

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

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

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

readInt

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

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

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

readLong

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

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

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

readFloat

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

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

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

readDouble

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

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

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

readBigDecimal

public BigDecimal readBigDecimal() throws SQLException
Возвращает следующий атрибут в этом объекте SQLInputImpl в качестве java.math.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 объекте как поток символов Юникод.

Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегируется отображению 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.
Specified by:
readNClob в интерфейсе SQLInput
Returns:
объект NClob , представляющий данные значения SQL NCLOB в начале потока; null если считанное значение — SQL NULL
Throws:
SQLException — если произошла ошибка доступа к базе данных
Since:
1.6

readNString

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

readSQLXML

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

readRowId

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

© 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.rowset/javax/sql/rowset/serial/SQLInputImpl.html

Spec-Zone.ru

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