Класс SerialClob

java.lang.Object

javax.sql.rowset.serial.SerialClob

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

public class SerialClob extends Object implements Clob, Serializable, Cloneable

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

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

Методы SerialClob позволяют получить подстроку из объекта 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` символов.

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

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

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

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, переданный в этот конструктор, должен возвращать значения не равные null для методов Clob.getCharacterStream() и Clob.getAsciiStream. Этот конструктор SerialClob не может сериализовать объект Clob в этом случае и выбросит исключение SQLException.

Параметры:

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

Исключения:

SerialException - если произошла ошибка во время сериализации

SQLException - если произошла ошибка SQL при получении CLOB; если объект 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 в виде потока Юникод-символов. В отличие от связанного метода getAsciiStream, поток создаётся независимо от того, был ли объект SerialClob создан с объектом Clob или массивом char.

Определено в:

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

Возвращает:

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

Исключения:

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

См. также:

getAsciiStream

public InputStream getAsciiStream() throws SerialException, SQLException

Возвращает значение CLOB, обозначенное этим объектом SerialClob, как поток ASCII. Этот метод перенаправляет вызов getAsciiStream к основному объекту Clob, если этот объект SerialClob был создан с объектом 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
Возвращает:: позицию, в которой начинается заданный объект Clob в этом объекте SerialClob, начиная с указанной начальной позиции
Исключения:: SerialException - если произошла ошибка при поиске подписи Clob; если метод free был ранее вызван для этого объекта; SQLException - если произошла ошибка при доступе к значению Clob из базы данных

setString

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

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

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

setString

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

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

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

setAsciiStream

public OutputStream setAsciiStream(long pos) throws SerialException, SQLException

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

Specified by:

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

Parameters:

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

Returns:

поток, в который можно записать символы в кодировке ASCII

Throws:

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

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

See Also:

setCharacterStream

public Writer setCharacterStream(long pos) throws SerialException, SQLException

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

Specified by:

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

Parameters:

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

Returns:

поток, в который можно записать символы в кодировке Unicode

Throws:

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

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

See Also:

truncate

public void truncate(long length) throws SerialException

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

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

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

getCharacterStream

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

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

Specified by:: getCharacterStream в интерфейсе Clob
Parameters:: pos - смещение до первого символа частичного значения для извлечения. Первый символ в SerialClob находится по позиции 1.; length - длина в символах частичного значения для извлечения.
Returns:: Reader, через который можно прочитать частичное значение SerialClob.
Throws:: SQLException - если pos меньше 1 или если pos больше числа символов в SerialClob или если pos + length больше числа символов в SerialClob;; SerialException - если метод free был ранее вызван для этого объекта
Since:: 1.6

free

public void free() throws SQLException

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

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

Specified by:: free в интерфейсе Clob
Throws:: SQLException - если произошла ошибка при высвобождении ресурсов Clob
Since:: 1.6

equals

public boolean equals(Object obj)

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


 true

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


 SerialClob

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

Overrides:

equals в классе Object

Parameters:

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

Returns:

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

See Also:

hashCode

public int hashCode()

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

Overrides:

hashCode в классе Object

Returns:

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

See Also:

clone

public Object clone()

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

Overrides:

clone в классе Object

Returns:

клон этого SerialClob

See Also:

END_OF_DOCUMENT_MARKER

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