Интерфейс 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.

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

С:: 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 строку в значение 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

См. также:

Установить поток символов

Writer setCharacterStream(long pos) throws SQLException

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

1.4

См. также:

обрезка

void truncate(long len) throws SQLException

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

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

освободить

void free() throws SQLException

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

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

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

получить поток символов

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://download.java.net/java/early_access/jdk24/docs/api/java.sql/java/sql/Clob.html