Класс SerialClob
- Все реализованные интерфейсы:
-
Serializable,Cloneable,Clob
public class SerialClob extends Object implements Clob, Serializable, Cloneable
CLOB. Класс SerialClob предоставляет конструктор для создания экземпляра из объекта Clob. Обратите внимание, что объект Clob должен был передать данные значения SQL CLOB клиенту перед созданием объекта SerialClob из него. Данные значения SQL CLOB могут быть материализованы на клиенте как поток Юникод-символов.
Методы SerialClob позволяют получить подстроку из объекта SerialClob или определить начало шаблона символов.
Безопасность потоков
Объект SerialClob не безопасен для использования несколькими потоками одновременно. Если SerialClob будет использоваться более чем одним потоком, то доступ к SerialClob должен контролироваться соответствующей синхронизацией.
- С:
- 1.5
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
SerialClob |
Создает объект SerialClob, который является сериализованной версией заданного массива char. |
SerialClob |
Создает объект SerialClob, который является сериализованной версией заданного объекта Clob. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Object |
clone() |
Возвращает копию этого SerialClob. |
boolean |
equals |
Сравнивает этот SerialClob с указанным объектом. |
void |
free() |
Этот метод освобождает объект SerialClob и освобождает ресурсы, которые он удерживает. |
InputStream |
getAsciiStream() |
Извлекает значение CLOB , обозначенное этим объектом SerialClob, в виде потока ascii. |
Reader |
getCharacterStream() |
Возвращает данные этого объекта SerialClob в виде потока Юникод-символов. |
Reader |
getCharacterStream |
Возвращает объект Reader, содержащий частичное значение SerialClob, начиная с символа, указанного pos, длиной в length символов. |
String |
getSubString |
Возвращает копию подстроки, содержащейся в этом объекте SerialClob, начиная с указанной позиции и продолжающейся на указанное количество символов. |
int |
hashCode() |
Возвращает хэш-код для этого SerialClob. |
long |
length() |
Извлекает количество символов в массиве символов этого объекта SerialClob. |
long |
position |
Возвращает позицию в этом объекте SerialClob, где начинается заданный объект String, начиная поиск с указанной позиции. |
long |
position |
Возвращает позицию в этом объекте SerialClob, где начинается заданная подпись Clob, начиная поиск с указанной позиции. |
OutputStream |
setAsciiStream |
Извлекает поток для записи символов Ascii в значение CLOB , которое представляет этот объект SerialClob, начиная с позиции pos. |
Writer |
setCharacterStream |
Извлекает поток для записи потока Юникод-символов в значение CLOB , которое представляет этот объект SerialClob, по позиции pos. |
int |
setString |
Записывает данный Java String в значение CLOB , которое представляет этот объект SerialClob, по позиции pos. |
int |
setString |
Записывает len символов str, начиная с символа offset, в значение CLOB , которое представляет этот объект Clob. |
void |
truncate |
Усекает значение CLOB , которое представляет этот объект SerialClob, так, чтобы его длина была len символов. |
Подробное описание конструкторов
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. Данный метод перенаправляет вызов 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
CLOB, представленное этим объектом SerialClob, по позиции pos.- Унаследованно от:
-
setStringв интерфейсеClob - Параметры:
-
pos- позиция начала записи в значениеCLOB, представленное этим объектомSerialClob; первая позиция -1; не должно быть меньше1и больше длины+1 объектаSerialClob -
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.- 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
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
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)
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:
© 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/SerialClob.html