Класс 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 как поток символов 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 структурированным или distinct типом с пользовательским отображением, этот метод определяет 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, 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.rowset/javax/sql/rowset/serial/SQLInputImpl.html

Spec-Zone .ru
спецификации, руководства, описания, API