Spec-Zone.ru › OpenJDK 21

Класс 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 могут быть материализованы на клиенте как поток Юникод-символов.

Методы 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 в виде потока Юникод-символов.
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)
Извлекает поток для записи потока Юникод-символов в значение 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 , переданный в этот конструктор, должен возвращать ненулевые значения для методов 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. Данный метод перенаправляет вызов getAsciiStream к базовому объекту Clob, если этот объект SerialClob был создан с объектом 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 в значение 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
Возвращает поток для записи символов 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:
  • getAsciiStream()

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:
  • getCharacterStream()

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:
  • Object.hashCode()
  • HashMap

hashCode

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

clone

public Object clone()
Возвращает копию этого SerialClob. Копия будет содержать ссылку на копию внутреннего массива символов, а не на ссылку на исходный внутренний массив символов этого объекта SerialClob. Внутренний объект Clob будет установлен в null.
Overrides:
clone в классе Object
Returns:
копия этого SerialClob
See Also:
  • 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/SerialClob.html

Spec-Zone.ru

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