Класс SerialArray

java.lang.Object

javax.sql.rowset.serial.SerialArray

Все реализованные интерфейсы:: Serializable, Cloneable, Array

public class SerialArray extends Object implements Array, Serializable, Cloneable

Сериализованная версия объекта Array, являющегося отображением значения SQL ARRAY на языке программирования Java.

Класс SerialArray предоставляет конструктор для создания экземпляра SerialArray из объекта Array, методы для получения базового типа и имени SQL для базового типа, а также методы для копирования всего или части объекта SerialArray.

Примечание: для правильной работы этого класса необходимо наличие подключения к источнику данных, чтобы объект SQL Array был материализован (все его элементы были доставлены на клиентский сервер), если это необходимо. В настоящее время логические указатели на данные в источнике данных, такие как локаторы, не поддерживаются.

Безопасность потоков

Объект SerialArray не безопасен для использования в нескольких потоках одновременно. Если SerialArray будет использоваться более чем одним потоком, доступ к SerialArray должен контролироваться соответствующей синхронизацией.

C момента:

1.5

См. также:

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

Конструктор	Описание
`SerialArray(Array array)`	Создает новый объект `SerialArray` из заданного объекта `Array`.
`SerialArray(Array array, Map<String,Class<?>> map)`	Создает новый объект `SerialArray` из заданного объекта `Array`, используя заданную карту типов для пользовательского сопоставления каждого элемента, когда элементы являются SQL UDT.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает клон этого объекта `SerialArray`.
`boolean`	`equals(Object obj)`	Сравнивает этот SerialArray со заданным объектом.
`void`	`free()`	Этот метод освобождает объект `SerialArray` и освобождает ресурсы, которые он удерживает.
`Object`	`getArray()`	Возвращает новый массив, который является копией этого объекта `SerialArray`.
`Object`	`getArray(long index, int count)`	Возвращает новый массив, который является копией фрагмента этого объекта `SerialArray`, начиная с элемента с заданным индексом и содержащего заданное количество последовательных элементов.
`Object`	`getArray(long index, int count, Map<String,Class<?>> map)`	Возвращает новый массив, который является копией фрагмента этого объекта `SerialArray`, начиная с элемента с заданным индексом и содержащего заданное количество последовательных элементов.
`Object`	`getArray(Map<String,Class<?>> map)`	Возвращает новый массив, который является копией этого объекта `SerialArray`, используя заданную карту типов для пользовательского сопоставления каждого элемента, когда элементы являются SQL UDT.
`int`	`getBaseType()`	Извлекает тип SQL элементов в этом объекте `SerialArray`.
`String`	`getBaseTypeName()`	Извлекает имя типа, специфичное для СУБД, для элементов в этом объекте `SerialArray`.
`ResultSet`	`getResultSet()`	Извлекает объект `ResultSet`, содержащий все элементы в значении SQL `ARRAY`, которое представляет этот объект `SerialArray`.
`ResultSet`	`getResultSet(long index, int count)`	Извлекает объект `ResultSet`, содержащий элементы подмассива, начинающегося с индекса index и содержащего до count последовательных элементов.
`ResultSet`	`getResultSet(long index, int count, Map<String,Class<?>> map)`	Извлекает набор результатов, содержащий элементы подмассива, начинающегося с индекса Извлекает объект `ResultSet`, содержащий подмассив элементов в этом объекте `SerialArray`, начинающийся с индекса index и содержащий до count последовательных элементов.
`ResultSet`	`getResultSet(Map<String,Class<?>> map)`	Извлекает объект `ResultSet`, содержащий все элементы значения SQL `ARRAY`, представленного этим объектом `SerialArray`.
`int`	`hashCode()`	Возвращает хэш-код для этого SerialArray.

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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

SerialArray

public SerialArray(Array array, Map<String,Class<?>> map) throws SerialException, SQLException

Создаёт новый объект SerialArray из заданного объекта Array, используя заданную карту типов для пользовательского отображения каждого элемента, когда элементы являются SQL UDT.

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

Новый объект SerialArray содержит те же элементы, что и объект Array, из которого он создан, за исключением случаев, когда базовый тип является SQL-типом STRUCT, ARRAY, BLOB, CLOB, DATALINK или JAVA_OBJECT. В этом случае каждый элемент в новом объекте SerialArray представляет собой соответствующую сериализованную форму, то есть объект SerialStruct, SerialArray, SerialBlob, SerialClob, SerialDatalink или SerialJavaObject.

Примечание: (1) Объект Array, из которого создаётся объект SerialArray, должен материализовать данные SQL-значения ARRAY на клиенте перед передачей в конструктор. В противном случае новый объект SerialArray не будет содержать данных.

Примечание: (2) Если Array содержит типы java.sql.Types.JAVA_OBJECT, вызывается конструктор SerialJavaObject, где выполняются проверки для обеспечения сериализуемости этого объекта.

Примечание: (3) Объект Array, предоставленный этому конструктору, не может возвращать null для каких-либо методов Array.getArray(). SerialArray не может сериализовать нулевые значения массивов.

Параметры:: array - объект Array, который необходимо сериализовать; map - объект java.util.Map, в котором каждая запись состоит из 1) объекта String, указывающего полное имя UDT (SQL-структурированного типа или типа-различия), и 2) объекта Class для реализации SQLData, которая определяет, как отображается UDT. Параметр map не оказывает никакого влияния для типов Blob, Clob, DATALINK или JAVA_OBJECT.
Исключения:: SerialException - если произошла ошибка при сериализации объекта Array; SQLException - если произошла ошибка доступа к базе данных или значения array или map являются null

SerialArray

public SerialArray(Array array) throws SerialException, SQLException

Создаёт новый объект SerialArray из заданного объекта Array.

Этот конструктор не выполняет пользовательское отображение. Если базовый тип массива является SQL-структурированным типом и необходимо пользовательское отображение, следует использовать конструктор SerialArray(Array array, Map map).

Новый объект SerialArray содержит те же элементы, что и объект Array, из которого он создан, за исключением случаев, когда базовый тип является SQL-типом BLOB, CLOB, DATALINK или JAVA_OBJECT. В этом случае каждый элемент в новом объекте SerialArray представляет собой соответствующую сериализованную форму, то есть объект SerialBlob, SerialClob, SerialDatalink или SerialJavaObject.

Примечание: (2) Объект Array, предоставленный этому конструктору, не может возвращать null для каких-либо методов Array.getArray(). SerialArray не может сериализовать нулевые значения массивов null.

Параметры:: array - объект Array, который необходимо сериализовать
Исключения:: SerialException - если произошла ошибка при сериализации объекта Array; SQLException - если произошла ошибка доступа к базе данных или параметр array является null.

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

free

public void free() throws SQLException

Этот метод освобождает объект SerialArray и высвобождает ресурсы, которые он удерживает. Объект становится недействительным после вызова метода free.

Если метод free вызывается несколько раз, последующие вызовы к free обрабатываются как no-op.

Определено в:: free в интерфейсе Array
Исключения:: SQLException - если произошла ошибка при освобождении ресурсов SerialArray
Введено:: 1.6

getArray

public Object getArray() throws SerialException

Возвращает новый массив, являющийся копией этого объекта SerialArray.

Определено в:: getArray в интерфейсе Array
Возвращает:: копию этого объекта SerialArray в виде объекта Object языка программирования Java
Исключения:: SerialException - если произошла ошибка; если метод free был ранее вызван для этого объекта

getArray

public Object getArray(Map<String,Class<?>> map) throws SerialException

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

Определено в:: getArray в интерфейсе Array
Параметры:: map - объект java.util.Map, в котором каждая запись состоит из 1) объекта String, указывающего полное имя UDT, и 2) объекта Class для реализации SQLData, которая определяет, как отображается UDT
Возвращает:: копию этого объекта SerialArray в виде объекта Object языка программирования Java
Исключения:: SerialException - если произошла ошибка; если метод free был ранее вызван для этого объекта

getArray

public Object getArray(long index, int count) throws SerialException

Возвращает новый массив, являющийся копией фрагмента этого объекта SerialArray, начиная с элемента с заданным индексом и содержащего заданное количество последовательных элементов.

Определено в:: getArray в интерфейсе Array
Параметры:: index - индекс в этом объекте SerialArray первого копируемого элемента; индекс первого элемента равен 0; count - количество последовательных элементов, подлежащих копированию, начиная с заданного индекса
Возвращает:: копию указанных элементов в этом объекте SerialArray в виде объекта Object языка программирования Java
Исключения:: SerialException - если произошла ошибка; если метод free был ранее вызван для этого объекта

getArray

public Object getArray(long index, int count, Map<String,Class<?>> map) throws SerialException

Определено в:: getArray в интерфейсе Array
Параметры:: index - индекс в этом объекте SerialArray первого копируемого элемента; индекс первого элемента в массиве равен 0; count - количество последовательных элементов, подлежащих копированию, начиная с заданного индекса; map - объект java.util.Map, в котором каждая запись состоит из 1) объекта String, указывающего полное имя UDT, и 2) объекта Class для реализации SQLData, которая определяет, как отображается UDT
Возвращает:: копию указанных элементов в этом объекте SerialArray в виде объекта Object языка программирования Java
Исключения:: SerialException - если произошла ошибка; если метод free был ранее вызван для этого объекта

getBaseType

public int getBaseType() throws SerialException

Извлекает тип SQL элементов в этом объекте SerialArray. Возвращаемое значение является одной из констант в классе java.sql.Types.

Указано в:: getBaseType в интерфейсе Array
Возвращает:: одну из констант в java.sql.Types, указывающую на тип SQL элементов в этом объекте SerialArray
Исключения:: SerialException - если произошла ошибка; если free был ранее вызван для этого объекта

getBaseTypeName

public String getBaseTypeName() throws SerialException

Извлекает имя типа, зависящее от СУБД, для элементов в этом объекте SerialArray.

Указано в:: getBaseTypeName в интерфейсе Array
Возвращает:: имя типа SQL, используемое СУБД для базового типа этого объекта SerialArray
Исключения:: SerialException - если произошла ошибка; если free был ранее вызван для этого объекта

getResultSet

public ResultSet getResultSet(long index, int count) throws SerialException

Извлекает объект ResultSet, содержащий элементы подмассива, начинающегося с индекса index и содержащего до count последовательных элементов. Этот метод использует карту типов соединения для сопоставления элементов массива, если карта содержит запись для базового типа. В противном случае используется стандартное сопоставление.

Указано в:: getResultSet в интерфейсе Array
Параметры:: index - индекс в этом объекте SerialArray первого элемента для копирования; индекс первого элемента в массиве - 0; count - количество последовательных элементов для копирования, начиная с указанного индекса
Возвращает:: объект ResultSet, содержащий указанные элементы в этом объекте SerialArray, с отдельной строкой для каждого элемента
Исключения:: SerialException - если вызывается с причиной, установленной в UnsupportedOperationException

getResultSet

public ResultSet getResultSet(Map<String,Class<?>> map) throws SerialException

Извлекает объект ResultSet, который содержит все элементы значения SQL ARRAY, представленного этим объектом SerialArray. Этот метод использует указанную карту для настройки карты типов, если базовый тип массива не соответствует определенному пользователем типу (UDT) в map, в этом случае используется стандартное сопоставление. Эта версия метода getResultSet использует либо заданную карту типов, либо стандартное сопоставление; она никогда не использует карту типов, связанную с соединением.

Указано в:: getResultSet в интерфейсе Array
Параметры:: map - объект java.util.Map, в котором каждая запись состоит из 1) объекта String, содержащего полное квалифицированное имя UDT и 2) объекта Class для реализации SQLData, которая определяет, как следует сопоставлять UDT
Возвращает:: объект ResultSet, содержащий все элементы в этом объекте SerialArray, с отдельной строкой для каждого элемента
Исключения:: SerialException - если вызывается с причиной, установленной в UnsupportedOperationException

getResultSet

public ResultSet getResultSet() throws SerialException

Извлекает объект ResultSet, содержащий все элементы значения ARRAY, которое представляет этот объект SerialArray. Если необходимо, элементы массива сопоставляются с использованием карты типов соединения; в противном случае используется стандартное сопоставление.

Указано в:: getResultSet в интерфейсе Array
Возвращает:: объект ResultSet, содержащий все элементы в этом объекте SerialArray, с отдельной строкой для каждого элемента
Исключения:: SerialException - если вызывается с причиной, установленной в UnsupportedOperationException

getResultSet

public ResultSet getResultSet(long index, int count, Map<String,Class<?>> map) throws SerialException

Извлекает результирующий набор, содержащий элементы подмассива, начинающегося с Извлекает объект ResultSet, который содержит подмассив элементов в этом объекте SerialArray, начиная с индекса index и содержащий до count последовательных элементов. Этот метод использует указанную карту для настройки карты типов, если базовый тип массива не соответствует определенному пользователем типу (UDT) в map, в этом случае используется стандартное сопоставление. Эта версия метода getResultSet использует либо заданную карту типов, либо стандартное сопоставление; она никогда не использует карту типов, связанную с соединением.

Указано в:: getResultSet в интерфейсе Array
Параметры:: index - индекс в этом объекте SerialArray первого элемента для копирования; индекс первого элемента в массиве - 0; count - количество последовательных элементов для копирования, начиная с указанного индекса; map - объект java.util.Map, в котором каждая запись состоит из 1) объекта String, содержащего полное квалифицированное имя UDT и 2) объекта Class для реализации SQLData, которая определяет, как следует сопоставлять UDT
Возвращает:: объект ResultSet, содержащий указанные элементы в этом объекте SerialArray, с отдельной строкой для каждого элемента
Исключения:: SerialException - если вызывается с причиной, установленной в UnsupportedOperationException

equals

public boolean equals(Object obj)

Сравнивает этот SerialArray с указанным объектом. Результат равен


 true

тогда и только тогда, когда аргумент не null и является объектом


 SerialArray

, элементы которого идентичны элементам этого объекта

Переопределяет:

equals в классе Object

Параметры:

obj - Объект для сравнения этого SerialArray

Возвращает:

true если данный объект представляет SerialArray эквивалентный этому SerialArray, false в противном случае

См. также:

hashCode

public int hashCode()

Возвращает хэш-код для этого SerialArray. Хэш-код для объекта SerialArray вычисляется с использованием хэш-кодов элементов объекта SerialArray

Переопределяет:

hashCode в классе Object

Возвращает:

значение хэш-кода для этого объекта.

См. также:

clone

public Object clone()

Возвращает клон этого SerialArray. Копия будет содержать ссылку на клон базового массива объектов, а не ссылку на исходный базовый массив объектов этого объекта SerialArray.

Переопределяет:

clone в классе Object

Возвращает:

клон этого SerialArray

См. также:

© 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/SerialArray.html