Spec-Zone.ru › OpenJDK 25

Класс SerialClob

java.lang.Object
javax.sql.rowset.serial.SerialClob
Все реализуемые интерфейсы:
Serializable, 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

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

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
См. также:
  • Clob

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

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
См. также:
  • Clob.setCharacterStream(long)

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, произошла ошибка
См. также:
  • Clob.setAsciiStream(long)

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.
Определено в:
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 произошла ошибка
См. также:
  • getAsciiStream()

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 произошла ошибка
См. также:
  • getCharacterStream()

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 в противном случае
См. также:
  • Object.hashCode()
  • HashMap

hashCode

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

clone

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

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, общие сведения, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.sql.rowset/javax/sql/rowset/serial/SerialClob.html

Spec-Zone.ru

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