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

Методы

length

public long length()
            throws SerialException

Извлекает количество символов в массиве символов этого объекта SerialClob.

Указано в:
length в интерфейсе Clob
Возвращает:
a 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 String в значение CLOB, которое представляет этот объект SerialClob, в позиции pos.

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

setAsciiStream

public OutputStream setAsciiStream(long pos)
                            throws SerialException,
                                   SQLException

Извлекает поток, который будет использоваться для записи символов ASCII в значение CLOB, которое представляет этот объект SerialClob, начиная с позиции pos. Этот метод переадресует вызов setAsciiStream() базовому объекту Clob в случае, если этот объект SerialClob создан с объектом 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

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

Определено в:
setCharacterStream в интерфейсе Clob
Параметры:
pos - позиция, с которой начинается запись в значение CLOB
Возвращает:
поток, в который можно записывать символы, закодированные в Юникоде
Исключения:
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 или если pos больше числа символов в 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(java.lang.Object)

clone

public Object clone()

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

Переопределяет:
clone в классе Object
Возвращает:
клон этого SerialClob
См. также:
Cloneable

© 1993, 2020, 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/11/docs/api/java.sql.rowset/javax/sql/rowset/serial/SerialClob.html

Spec-Zone .ru
спецификации, руководства, описания, API