Класс SerialClob

java.lang.Object

javax.sql.rowset.serial.SerialClob

Все реализуемые интерфейсы:: Serializable, AutoCloseable, Cloneable, Clob

public class SerialClob extends Object implements Clob, Serializable, Cloneable

Сериализованное представление значения SQL CLOB на языке программирования Java.

Класс SerialClob предоставляет конструктор для создания экземпляра из объекта Clob. Обратите внимание, что объект Clob должен был передать данные значения SQL CLOB клиенту до создания из него объекта SerialClob. Данные значения SQL CLOB могут быть материализованы на стороне клиента в виде потока символов Unicode.

Методы SerialClob позволяют получить подстроку из объекта SerialClob или найти начало шаблона символов.

Потокобезопасность

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

Начиная с:

1.5

См. также:

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

Конструктор	Описание
`SerialClob(char[] ch)`	Создает объект `SerialClob`, представляющий сериализованную версию указанного массива `char`.
`SerialClob(Clob clob)`	Создает объект `SerialClob`, представляющий сериализованную версию указанного объекта `Clob`.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает клонированную копию этого объекта `SerialClob`.
`boolean`	`equals(Object obj)`	Сравнивает этот объект SerialClob с указанным объектом.
`void`	`free()`	Этот метод освобождает объект `SerialClob` и высвобождает удерживаемые им ресурсы.
`InputStream`	`getAsciiStream()`	Возвращает значение `CLOB`, обозначенное этим объектом `SerialClob`, в виде потока ASCII.
`Reader`	`getCharacterStream()`	Возвращает данные этого объекта `SerialClob` в виде потока символов Unicode.
`Reader`	`getCharacterStream(long pos, long length)`	Возвращает объект `Reader`, содержащий частичное значение `SerialClob`, начинающееся с символа, указанного параметром pos, и имеющее длину length символов.
`String`	`getSubString(long pos, int length)`	Возвращает копию подстроки, содержащейся в этом объекте `SerialClob`, начиная с указанной позиции и продолжая указанное количество символов.
`int`	`hashCode()`	Возвращает хеш-код этого объекта `SerialClob`.
`long`	`length()`	Возвращает количество символов в массиве символов этого объекта `SerialClob`.
`long`	`position(String searchStr, long start)`	Возвращает позицию в этом объекте `SerialClob`, с которой начинается указанный объект `String`, начиная поиск с указанной позиции.
`long`	`position(Clob searchStr, long start)`	Возвращает позицию в этом объекте `SerialClob`, с которой начинается указанная сигнатура `Clob`, начиная поиск с указанной позиции.
`OutputStream`	`setAsciiStream(long pos)`	Возвращает поток для записи символов ASCII в значение `CLOB`, представленное этим объектом `SerialClob`, начиная с позиции `pos`.
`Writer`	`setCharacterStream(long pos)`	Возвращает поток для записи потока символов Unicode в значение `CLOB`, представленное этим объектом `SerialClob`, начиная с позиции `pos`.
`int`	`setString(long pos, String str)`	Записывает указанный объект Java `String` в значение `CLOB`, представленное этим объектом `SerialClob`, начиная с позиции `pos`.
`int`	`setString(long pos, String str, int offset, int length)`	Записывает `len` символов из `str`, начиная с символа `offset`, в значение `CLOB`, представленное этим объектом `Clob`.
`void`	`truncate(long length)`	Усекает значение `CLOB`, представленное этим объектом `SerialClob`, до длины `len` символов.

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

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

Модификатор и тип	Метод	Описание
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация признана устаревшей и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого объекта `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.

Методы, объявленные в интерфейсе Clob

close

Модификатор и тип	Метод	Описание
`default void`	`close()`	Закрывает объект `Clob` и освобождает удерживаемые им ресурсы.

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

SerialClob

public SerialClob(char[] ch) throws SerialException, SQLException

Создает объект SerialClob, представляющий собой сериализованную версию заданного массива char.

Новый объект SerialClob инициализируется данными из массива char, что позволяет автономным объектам RowSet создать сериализованный объект Clob, не обращаясь к источнику данных.

Параметры:: ch — массив char, представляющий сериализуемый объект Clob
Исключения:: SerialException — если во время сериализации возникает ошибка; SQLException — если возникает ошибка SQL

SerialClob

public SerialClob(Clob clob) throws SerialException, SQLException

Создает объект SerialClob, представляющий собой сериализованную версию заданного объекта Clob.

Новый объект SerialClob инициализируется данными из объекта Clob; поэтому объект Clob должен предварительно получить данные значения SQL CLOB из базы данных на клиент. В противном случае новый объект SerialClob не будет содержать данных.

Примечание: переданный этому конструктору объект Clob должен возвращать ненулевое значение для методов Clob.getCharacterStream() и Clob.getAsciiStream. Этот конструктор SerialClob не может сериализовать объект Clob в данном случае и вызовет объект SQLException.

Параметры:

clob — объект Clob, из которого создается этот объект SerialClob; не может быть null

Исключения:

SerialException — если во время сериализации возникает ошибка

SQLException — если при получении CLOB возникает ошибка SQL; если объект Clob имеет значение null; или если один из методов Clob.getCharacterStream() и Clob.getAsciiStream() объекта Clob возвращает null

См. также:

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

length

public long length() throws SerialException

Возвращает количество символов в массиве символов объекта SerialClob.

Определен в:: length в интерфейсе Clob
Возвращает:: значение long, указывающее длину в символах массива символов объекта SerialClob
Исключения:: SerialException — если возникает ошибка; если для этого объекта ранее был вызван free

getCharacterStream

public Reader getCharacterStream() throws SerialException

Возвращает данные объекта SerialClob в виде потока символов Unicode. В отличие от связанного метода getAsciiStream, поток создается независимо от того, был ли объект SerialClob создан с объектом Clob или массивом char.

Определен в:

getCharacterStream в интерфейсе Clob

Возвращает:

объект java.io.Reader, содержащий данные объекта SerialClob

Исключения:

SerialException — если возникает ошибка; если для этого объекта ранее был вызван free

См. также:

getAsciiStream

public InputStream getAsciiStream() throws SerialException, SQLException

Возвращает значение CLOB, представленное этим объектом SerialClob, в виде потока ASCII. Если этот объект SerialClob создан с объектом Clob, данный метод передает вызов getAsciiStream базовому объекту Clob. Если этот объект SerialClob создан с массивом char, выбрасывается объект SerialException.

Определен в:

getAsciiStream в интерфейсе Clob

Возвращает:

объект java.io.InputStream, содержащий данные объекта SerialClob

Исключения:

SerialException — если этот объект SerialClob создан не с объектом Clob; если для этого объекта ранее был вызван free

SQLException — если при доступе к значению CLOB, представленному объектом Clob, использованным для создания этого объекта SerialClob, возникает ошибка

См. также:

getSubString

public String getSubString(long pos, int length) throws SerialException

Возвращает копию подстроки, содержащейся в объекте SerialClob, начиная с заданной позиции и включающей указанное количество символов.

Определен в:: getSubString в интерфейсе Clob
Параметры:: pos — позиция первого символа копируемой подстроки; первый символ объекта SerialClob находится в позиции 1; значение не должно быть меньше 1, а сумма начальной позиции и длины подстроки должна быть меньше длины этого объекта SerialClob; length — количество символов в возвращаемой подстроке; значение не должно быть больше длины этого объекта SerialClob, а сумма начальной позиции и длины подстроки должна быть меньше длины этого объекта SerialClob
Возвращает:: объект String, содержащий подстроку этого объекта SerialClob, начинающуюся с заданной позиции и включающую указанное количество последовательных символов
Исключения:: SerialException — если один из аргументов выходит за допустимые границы; если для этого объекта ранее был вызван free

position

public long position(String searchStr, long start) throws SerialException, SQLException

Возвращает позицию в объекте SerialClob, с которой начинается заданный объект String, начиная поиск с указанной позиции. Если шаблон не найден, метод возвращает -1.

Определен в:: position в интерфейсе Clob
Параметры:: searchStr — объект String, который требуется найти; start — позиция в объекте SerialClob, с которой начинается поиск; первая позиция — 1; значение не должно быть меньше 1 или больше длины этого объекта SerialClob
Возвращает:: позицию, с которой начинается заданный объект String, начиная поиск с указанной позиции; -1, если заданный объект String не найден или начальная позиция выходит за допустимые границы; нумерация позиций возвращаемого значения начинается с 1
Исключения:: SerialException — если для этого объекта ранее был вызван метод free; SQLException — если при доступе к значению Clob из базы данных возникает ошибка.

position

public long position(Clob searchStr, long start) throws SerialException, SQLException

Возвращает позицию в объекте SerialClob, с которой начинается заданная сигнатура Clob, начиная поиск с указанной позиции. Если шаблон не найден, метод возвращает -1.

Определен в:: position в интерфейсе Clob
Параметры:: searchStr — объект Clob, который требуется найти; start — позиция в объекте SerialClob, с которой начинается поиск; первая позиция — 1; значение не должно быть меньше 1 или больше длины этого объекта SerialClob
Возвращает:: позицию в объекте SerialClob, с которой начинается заданный объект Clob, начиная с указанной начальной позиции или после нее
Исключения:: SerialException — если при поиске сигнатуры Clob возникает ошибка; если для этого объекта ранее был вызван метод free; SQLException — если при доступе к значению Clob из базы данных возникает ошибка

setString

public int setString(long pos, String str) throws SerialException

Записывает заданную строку Java String в значение CLOB, представленное этим объектом SerialClob, начиная с позиции pos.

Определен в:: setString в интерфейсе Clob
Параметры:: pos — позиция, с которой начинается запись в значение CLOB, представленное этим объектом SerialClob; первая позиция — 1; значение не должно быть меньше 1 или больше длины этого объекта SerialClob + 1; str — строка, записываемая в значение CLOB, представленное этим объектом SerialClob
Возвращает:: количество записанных символов
Исключения:: SerialException — если при доступе к значению CLOB возникает ошибка; если задана недопустимая позиция; если для этого объекта ранее был вызван метод free

setString

public int setString(long pos, String str, int offset, int length) throws SerialException

Записывает len символов из str, начиная с символа offset, в значение CLOB, представленное этим объектом Clob.

Определен в:: setString в интерфейсе Clob
Параметры:: pos — позиция, с которой начинается запись в значение CLOB, представленное этим объектом SerialClob; первая позиция — 1; значение не должно быть меньше 1 или больше длины этого объекта SerialClob + 1; str — строка, записываемая в значение CLOB, представленное этим объектом Clob; offset — смещение в str, с которого начинается чтение записываемых символов; length — количество записываемых символов
Возвращает:: количество записанных символов
Исключения:: SerialException — если при доступе к значению CLOB возникает ошибка; если задана недопустимая позиция или недопустимое значение смещения; или если сумма значений length и offset превышает длину str; если для этого объекта ранее был вызван метод free

setAsciiStream

public OutputStream setAsciiStream(long pos) throws SerialException, SQLException

Возвращает поток для записи символов ASCII в значение CLOB, представленное этим объектом SerialClob, начиная с позиции pos. Если этот объект SerialClob создан с объектом Clob, данный метод передает вызов setAsciiStream() базовому объекту Clob. Если этот объект SerialClob создан с массивом char, выбрасывается объект SerialException.

Определен в:

setAsciiStream в интерфейсе Clob

Параметры:

pos — позиция, с которой начинается запись в объект CLOB

Возвращает:

поток для записи символов в кодировке ASCII

Исключения:

SerialException — если SerialClob создан не с объектом Clob; если для этого объекта ранее был вызван метод free

SQLException — если при доступе к значению CLOB возникает ошибка

См. также:

setCharacterStream

public Writer setCharacterStream(long pos) throws SerialException, SQLException

Возвращает поток для записи потока символов Unicode в значение CLOB, представленное этим объектом SerialClob, начиная с позиции pos. Если этот объект SerialClob создан с объектом Clob, данный метод передает вызов setCharacterStream() базовому объекту Clob. Если этот объект SerialClob создан с массивом char, выбрасывается SerialException.

Определен в:

setCharacterStream в интерфейсе Clob

Параметры:

pos — позиция, с которой начинается запись в значение CLOB

Возвращает:

поток для записи символов в кодировке Unicode

Исключения:

SerialException — если SerialClob создан не с объектом Clob; если для этого объекта ранее был вызван метод free

SQLException — если при доступе к значению CLOB возникает ошибка

См. также:

truncate

public void truncate(long length) throws SerialException

Усекает значение CLOB, представленное этим объектом SerialClob, до длины len символов.

Усечение объекта SerialClob до длины 0 приводит к очистке его содержимого.

Определен в:: truncate в интерфейсе Clob
Параметры:: length — длина в байтах, до которой следует усечь значение CLOB
Исключения:: SerialException — если при доступе к значению CLOB возникает ошибка; если для этого объекта ранее был вызван метод free

getCharacterStream

public Reader getCharacterStream(long pos, long length) throws SQLException

Возвращает объект Reader, содержащий часть значения SerialClob, начиная с символа, указанного параметром pos, и имеющий длину length.

Определен в:: getCharacterStream в интерфейсе Clob
Параметры:: pos — смещение до первого символа извлекаемого фрагмента. Первый символ в SerialClob находится в позиции 1.; length — длина извлекаемого фрагмента в символах.
Возвращает:: Reader, через который можно прочитать часть значения SerialClob.
Исключения:: SQLException — если pos меньше 1, больше количества символов в SerialClob или если pos + length превышает количество символов в SerialClob;; SerialException — если для этого объекта ранее был вызван метод free
С версии:: 1.6

free

public void free() throws SQLException

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

При многократном вызове free последующие вызовы free не выполняют никаких действий.

Определен в:

free в интерфейсе Clob

Исключения:

SQLException — если при освобождении ресурсов Clob возникает ошибка

С версии:

1.6

См. также:

equals

public boolean equals(Object obj)

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


true

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


SerialClob

, представляющим ту же последовательность символов, что и этот объект.

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

equals в классе Object

Параметры:

obj — объект для сравнения с этим объектом SerialClob

Возвращает:

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

См. также:

hashCode

public int hashCode()

Возвращает хеш-код этого объекта SerialClob.

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

hashCode в классе Object

Возвращает:

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

См. также:

clone

public Object clone()

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

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

clone в классе Object

Возвращает:

копию этого объекта SerialClob

См. также:

© 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.