Класс 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) Создаёт объект |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
Array |
readArray() Читает значение SQL |
InputStream |
readAsciiStream() Возвращает следующий атрибут в этом объекте |
BigDecimal |
readBigDecimal() Получает следующий атрибут в этом объекте |
InputStream |
readBinaryStream() Возвращает следующий атрибут в этом объекте |
Blob |
readBlob() Получает значение |
boolean |
readBoolean() Получает следующий атрибут в этом объекте |
byte |
readByte() Получает следующий атрибут в этом объекте |
byte[] |
readBytes() Получает следующий атрибут в этом объекте |
Reader |
readCharacterStream() Получает следующий атрибут в этом объекте |
Clob |
readClob() Получает значение |
Date |
readDate() Получает следующий атрибут в этом объекте |
double |
readDouble() Получает следующий атрибут в этом объекте |
float |
readFloat() Получает следующий атрибут в этом объекте |
int |
readInt() Получает следующий атрибут в этом объекте |
long |
readLong() Получает следующий атрибут в этом объекте |
NClob |
readNClob() Читает значение SQL |
String |
readNString() Читает следующий атрибут в потоке и возвращает его как |
Object |
readObject() Получает значение в начале этого объекта |
Ref |
readRef() Получает значение в начале этого объекта |
RowId |
readRowId() Читает значение SQL |
short |
readShort() Получает следующий атрибут в этом объекте |
SQLXML |
readSQLXML() Читает значение SQL |
String |
readString() Получает следующий атрибут в этом объекте |
Time |
readTime() Получает следующий атрибут в этом объекте |
Timestamp |
readTimestamp() Получает следующий атрибут в этом объекте |
URL |
readURL() Читает значение SQL |
boolean |
wasNull() Определяет, было ли последнее прочитанное значение из этого объекта |
Методы, унаследованные от класса 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если значение равно SQLNULL - Бросает:
-
SQLException- если позиция чтения расположена в недопустимой позиции; или если в потоке больше нет значений.
readRef
public Ref readRef()
throws SQLException Извлекает значение в начале этого объекта SQLInputImpl как объект Ref в языке программирования Java.
- Указано:
-
readRefв интерфейсеSQLInput - Возвращает:
- объект
Refпредставляющий SQLREFзначение в начале потока; если значение равноSQL NULL, вернутьnull - Бросает:
-
SQLException- если позиция чтения расположена в недопустимой позиции; или если в потоке больше нет значений.
readBlob
public Blob readBlob()
throws SQLException Извлекает BLOB значение в начале этого объекта SQLInputImpl как объект Blob в языке программирования Java.
Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегируется отображению UDT, реализованному с помощью реализации SQLData.
- Указано:
-
readBlobв интерфейсеSQLInput - Возвращает:
- объект
Blobпредставляющий SQLBLOBзначение в начале потока; если значение равноSQL NULL, вернутьnull - Бросает:
-
SQLException- если позиция чтения расположена в недопустимой позиции; или если в потоке больше нет значений.
readClob
public Clob readClob()
throws SQLException Извлекает CLOB значение в начале этого объекта SQLInputImpl как объект Clob в языке программирования Java.
Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегируется отображению UDT, реализованному с помощью реализации SQLData.
- Указано:
-
readClobв интерфейсеSQLInput - Возвращает:
- объект
Clobпредставляющий SQLCLOBзначение в начале потока; если значение равноSQL NULL, вернутьnull - Бросает:
-
SQLException- если позиция чтения расположена в недопустимой позиции; или если в потоке больше нет значений.
readArray
public Array readArray()
throws SQLException Считывает значение SQL ARRAY из потока и возвращает его как объект Array в языке программирования Java.
Этот метод не выполняет проверку типа для определения, является ли возвращаемый тип ожидаемым типом, так как эта ответственность делегируется отображению UDT, реализованному с помощью реализации SQLData.
- Указано:
-
readArrayв интерфейсеSQLInput - Возвращает:
- объект
Arrayпредставляющий SQLARRAYзначение в начале потока; * если значение равно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представляющий SQLDATALINKзначение в начале потока; * если значение равноSQL NULL, вернутьnull - Бросает:
-
SQLException- если позиция чтения расположена в недопустимой позиции; или если в потоке больше нет значений.
readNClob
public NClob readNClob()
throws SQLException Считывает значение SQL NCLOB из потока и возвращает его как объект Clob в языке программирования Java.
- Указано:
-
readNClobв интерфейсеSQLInput - Возвращает:
- объект
NClobпредставляющий данные SQLNCLOBзначения в начале потока;nullесли прочитанное значение является SQLNULL - Бросает:
-
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представляющий данные SQLXMLзначения в начале потока;nullесли прочитанное значение является SQLNULL - Бросает:
-
SQLException- если произошла ошибка доступа к базе данных - С:
- 1.6
readRowId
public RowId readRowId()
throws SQLException Считывает значение SQL ROWID из потока и возвращает его как объект RowId в языке программирования Java.
- Указано:
-
readRowIdв интерфейсеSQLInput - Возвращает:
- объект
RowIdпредставляющий данные SQLROWIDзначения в начале потока;nullесли прочитанное значение является SQLNULL - Бросает:
-
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.