Интерфейс Clob

Все известные подинтерфейсы:: NClob

Все известные реализующие классы:: SerialClob

public interface Clob

Соответствие в языке программирования Java для типа SQL CLOB. SQL CLOB — это встроенный тип, который хранит символьный объект большого размера в качестве значения столбца строки таблицы базы данных. По умолчанию драйверы реализуют объект Clob с помощью SQL locator(CLOB), то есть объект Clob содержит логический указатель на данные SQL CLOB, а не сами данные. Объект Clob действителен в течение транзакции, в которой он был создан.

Интерфейс Clob предоставляет методы для получения длины значения SQL CLOB (символьного объекта большого размера), материализации значения CLOB на стороне клиента, а также для поиска подстроки или объекта CLOB в значении CLOB. Методы интерфейсов ResultSet, CallableStatement и PreparedStatement, такие как getClob и setClob, позволяют программисту получить доступ к значению SQL CLOB. Кроме того, этот интерфейс содержит методы для обновления значения CLOB.

Если драйвер JDBC поддерживает этот тип данных, все методы интерфейса Clob должны быть полностью реализованы.

С версии:: 1.2

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`free()`	Этот метод освобождает ресурсы, занятые объектом `Clob`.
`InputStream`	`getAsciiStream()`	Возвращает значение `CLOB`, обозначенное этим объектом `Clob`, в виде потока ASCII.
`Reader`	`getCharacterStream()`	Возвращает значение `CLOB`, обозначенное этим объектом `Clob`, в виде объекта `java.io.Reader` (или потока символов).
`Reader`	`getCharacterStream(long pos, long length)`	Возвращает объект `Reader`, содержащий часть значения `Clob`, начиная с символа, указанного параметром pos; длина этой части составляет length символов.
`String`	`getSubString(long pos, int length)`	Возвращает копию указанной подстроки в значении `CLOB`, обозначенном этим объектом `Clob`.
`long`	`length()`	Возвращает количество символов в значении `CLOB`, обозначенном этим объектом `Clob`.
`long`	`position(String searchstr, long start)`	Возвращает позицию символа, с которой указанная подстрока `searchstr` встречается в значении SQL `CLOB`, представленном этим объектом `Clob`.
`long`	`position(Clob searchstr, long start)`	Возвращает позицию символа, с которой указанный объект `Clob` `searchstr` встречается в этом объекте `Clob`.
`OutputStream`	`setAsciiStream(long pos)`	Возвращает поток для записи символов ASCII в значение `CLOB`, представленное этим объектом `Clob`, начиная с позиции `pos`.
`Writer`	`setCharacterStream(long pos)`	Возвращает поток для записи потока символов Unicode в значение `CLOB`, представленное этим объектом `Clob`, начиная с позиции `pos`.
`int`	`setString(long pos, String str)`	Записывает указанную строку Java `String` в значение `CLOB`, обозначенное этим объектом `Clob`, начиная с позиции `pos`.
`int`	`setString(long pos, String str, int offset, int len)`	Записывает `len` символов из `str`, начиная с символа `offset`, в значение `CLOB`, представленное этим объектом `Clob`.
`void`	`truncate(long len)`	Обрезает значение `CLOB`, обозначенное этим объектом `Clob`, до длины `len` символов.

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

length

long length() throws SQLException

Возвращает количество символов в значении CLOB, обозначенном этим объектом Clob.

Возвращает:: длину CLOB в символах
Вызывает исключение:: SQLException — если при получении длины значения CLOB произошла ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getSubString

String getSubString(long pos, int length) throws SQLException

Возвращает копию указанной подстроки в значении CLOB, обозначенном этим объектом Clob. Подстрока начинается с позиции pos и содержит не более length символов подряд.

Параметры:: pos — первый символ извлекаемой подстроки. Первый символ находится в позиции 1.; length — количество символов подряд, которые необходимо скопировать; значение length должно быть больше или равно 0
Возвращает:: объект String, содержащий указанную подстроку значения CLOB, обозначенного этим объектом Clob
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка; если pos меньше 1 или length меньше 0; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getCharacterStream

Reader getCharacterStream() throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, в виде объекта java.io.Reader (или потока символов).

Возвращает:

объект java.io.Reader, содержащий данные CLOB

Вызывает исключение:

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

SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод

С версии:

1.2

См. также:

getAsciiStream

InputStream getAsciiStream() throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, в виде потока ASCII.

Возвращает:

объект java.io.InputStream, содержащий данные CLOB

Вызывает исключение:

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

SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод

С версии:

1.2

См. также:

position

long position(String searchstr, long start) throws SQLException

Возвращает позицию символа, с которой указанная подстрока searchstr встречается в значении SQL CLOB, представленном этим объектом Clob. Поиск начинается с позиции start.

Параметры:: searchstr — подстрока для поиска; start — позиция, с которой следует начать поиск; первая позиция — 1
Возвращает:: позицию, в которой встречается подстрока, или -1, если она не найдена; первая позиция — 1
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка или если pos меньше 1; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

position

long position(Clob searchstr, long start) throws SQLException

Возвращает позицию символа, с которой указанный объект Clob searchstr встречается в этом объекте Clob. Поиск начинается с позиции start.

Параметры:: searchstr — объект Clob для поиска; start — позиция, с которой следует начать поиск; первая позиция — 1
Возвращает:: позицию, в которой встречается объект Clob, или -1, если он не найден; первая позиция — 1
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка или если start меньше 1; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

setString

int setString(long pos, String str) throws SQLException

Записывает указанную строку Java String в значение CLOB, обозначенное этим объектом Clob, начиная с позиции pos. Строка заменит существующие символы объекта Clob, начиная с позиции pos. Если при записи указанной строки будет достигнут конец значения Clob, длина значения Clob увеличится, чтобы вместить дополнительные символы.

Примечание: Если значение, указанное для pos, больше длины значения CLOB + 1, поведение не определено. Некоторые драйверы JDBC могут выбросить SQLException, тогда как другие драйверы могут поддерживать эту операцию.

Параметры:: pos — позиция, с которой следует начать запись в значение CLOB, представленное этим объектом Clob; первая позиция — 1.; str — строка для записи в значение CLOB, обозначенное этим объектом Clob
Возвращает:: количество записанных символов
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка или если pos меньше 1; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.4

setString

int setString(long pos, String str, int offset, int len) throws SQLException

Записывает len символов из str, начиная с символа offset, в значение CLOB, представленное этим объектом Clob. Строка заменит существующие символы объекта Clob, начиная с позиции pos. Если при записи указанной строки будет достигнут конец значения Clob, длина значения Clob увеличится, чтобы вместить дополнительные символы.

Параметры:: pos — позиция, с которой следует начать запись в этот объект CLOB; первая позиция — 1; str — строка для записи в значение CLOB, представленное этим объектом Clob; offset — смещение в str, с которого следует начать чтение записываемых символов; len — количество записываемых символов
Возвращает:: количество записанных символов
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка или если pos меньше 1; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.4

setAsciiStream

OutputStream setAsciiStream(long pos) throws SQLException

Возвращает поток для записи символов ASCII в значение CLOB, представленное этим объектом Clob, начиная с позиции pos. Записываемые в поток символы заменят существующие символы объекта Clob, начиная с позиции pos. Если при записи символов в поток будет достигнут конец значения Clob, длина значения Clob увеличится, чтобы вместить дополнительные символы.

Параметры:

pos — позиция, с которой следует начать запись в этот объект CLOB; первая позиция — 1

Возвращает:

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

Вызывает исключение:

SQLException — если при доступе к значению CLOB произошла ошибка или если pos меньше 1

SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод

С версии:

1.4

См. также:

setCharacterStream

Writer setCharacterStream(long pos) throws SQLException

Возвращает поток для записи потока символов Unicode в значение CLOB, представленное этим объектом Clob, начиная с позиции pos. Записываемые в поток символы заменят существующие символы объекта Clob, начиная с позиции pos. Если при записи символов в поток будет достигнут конец значения Clob, длина значения Clob увеличится, чтобы вместить дополнительные символы.

Параметры:

pos — позиция, с которой следует начать запись в значение CLOB; первая позиция — 1

Возвращает:

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

Вызывает исключение:

SQLException — если при доступе к значению CLOB произошла ошибка или если pos меньше 1

SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод

С версии:

1.4

См. также:

truncate

void truncate(long len) throws SQLException

Обрезает значение CLOB, обозначенное этим объектом Clob, до длины len символов.

Параметры:: len — длина в символах, до которой следует обрезать значение CLOB
Вызывает исключение:: SQLException — если при доступе к значению CLOB произошла ошибка или если len меньше 0; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.4

free

void free() throws SQLException

Этот метод освобождает ресурсы, занятые объектом Clob. После вызова метода free объект становится недействительным.

После вызова free любая попытка вызвать метод, отличный от free, приведет к выбрасыванию SQLException. Если free вызывается несколько раз, последующие вызовы free не выполняют никаких действий.

Вызывает исключение:: SQLException — если при освобождении ресурсов Clob произошла ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.6

getCharacterStream

Reader getCharacterStream(long pos, long length) throws SQLException

Возвращает объект Reader, содержащий часть значения Clob, начинающуюся с символа, указанного параметром pos, и имеющую длину length символов.

Параметры:: pos — смещение до первого символа извлекаемой части значения. Первый символ в Clob находится в позиции 1.; length — длина извлекаемой части значения в символах.
Возвращает:: Reader, через который можно прочитать часть значения Clob.
Вызывает исключение:: SQLException — если pos меньше 1; или если pos больше количества символов в Clob; или если pos + length больше количества символов в Clob; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.6

© 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/java/sql/Clob.html