Spec-Zone.ru › OpenJDK 21

Класс 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 следует контролировать с помощью соответствующей синхронизации.
С:
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.

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

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

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

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

free

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

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

Определено в:
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.

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

Определено в:
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
Возвращает новый массив, являющийся копией фрагмента этого объекта SerialArray, начиная с элемента с заданным индексом и содержащего заданное количество последовательных элементов.

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

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

getBaseTypeName

public String getBaseTypeName() throws SerialException
Получает имя типа, специфичное для DBMS, для элементов в этом SerialArray объекте.
Specified by:
getBaseTypeName в интерфейсе Array
Возвращает:
имя SQL типа, используемое DBMS для базового типа этого SerialArray объекта
Имеет исключения:
SerialException - если произошла ошибка; если free ранее был вызван для этого объекта

getResultSet

public ResultSet getResultSet(long index, int count) throws SerialException
Возвращает ResultSet объект, содержащий элементы подмассива, начинающегося с индекса index и содержащего до count последовательных элементов. Этот метод использует карту типов подключения для сопоставления элементов массива, если в карте есть запись для базового типа. В противном случае используется стандартное сопоставление.
Specified by:
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 использует либо заданную карту типов, либо стандартное сопоставление; она никогда не использует карту типов, связанную с подключением.
Specified by:
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 объект. При необходимости элементы массива сопоставляются с использованием карты типов подключения; в противном случае используется стандартное сопоставление.
Specified by:
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 использует либо заданную карту типов, либо стандартное сопоставление; она никогда не использует карту типов, связанную с подключением.
Specified by:
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 объектом, элементы которого идентичны элементам этого объекта.
Overrides:
equals в классе Object
Параметры:
obj - Объект для сравнения с этим SerialArray
Возвращает:
true , если заданный объект представляет SerialArray эквивалент этому SerialArray, false в противном случае
См. также:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()
Возвращает хеш-код для этого SerialArray. Хеш-код для SerialArray объекта вычисляется с использованием хеш-кодов элементов SerialArray объекта
Overrides:
hashCode в классе Object
Возвращает:
значение хеш-кода для этого объекта.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

clone

public Object clone()
Возвращает копию этого SerialArray. Копия будет содержать ссылку на клон массива базовых объектов, а не ссылку на исходный массив базовых объектов этого SerialArray объекта.
Overrides:
clone в классе Object
Возвращает:
клон этого SerialArray
См. также:
  • Cloneable

© 1993, 2023, 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/21/docs/api/java.sql.rowset/javax/sql/rowset/serial/SerialArray.html

Spec-Zone.ru

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