Класс SerialClob

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 должен контролироваться соответствующей синхронизацией.

Конструкторы

SerialClob

public SerialClob(char[] ch)
           throws SerialException,
                  SQLException

Параметры:

ch — массив char, представляющий сериализуемый объект Clob

Исключения:

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

SQLException — если произошла ошибка SQL

SerialClob

public SerialClob(Clob clob)
           throws SerialException,
                  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

Возвращает:

значение long, указывающее на длину в символах массива символов объекта SerialClob

Исключения:

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

getCharacterStream

public Reader getCharacterStream()
                          throws SerialException

Возвращает данные этого объекта SerialClob в виде потока символов Юникода. В отличие от родственного метода 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

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

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

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

Параметры:

pos - позиция для начала записи в значение CLOB

Возвращает:

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

Выбрасывает:

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

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

См. также:

getCharacterStream()

truncate

public void truncate(long length)
              throws SerialException

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

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

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

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