oracle.jdbc

Interface OracleClob

All Superinterfaces:

java.sql.Clob

All Known Subinterfaces:

OracleNClob

All Known Implementing Classes:

CLOB, NCLOB

public interface OracleClob
extends java.sql.Clob

This interface extends the standard JDBC interface Clob and defines methods for Oracle specific Clob .

Generally any new code should avoid the direct use of the class CLOB. For variable declarations use the interface Clob or this interface as required. Instead of the static methods CLOB.createTemporary(java.sql.Connection, boolean, int) and CLOB.empty_lob() please use Connection.createClob() and CLOB.getEmptyCLOB() respectively.

Since:

11.2.0.3

Method Summary

Modifier and Type	Method and Description
default void	close() Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to closeLob(), which provides the exact same behavior.
void	closeLob() Close a previously opened CLOB.
boolean	isEmptyLob() Return true if this is an empty lob.
default boolean	isOpen() Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to isOpenLob(), which provides the exact same behavior.
boolean	isOpenLob() Check whether the CLOB is opened.
boolean	isSecureFile() Returns true if this is a SecureFile (LOBs with the STORE AS SECUREFILE option, which were introduced in Oracle Database 11g Release 1).
boolean	isTemporary() Return true if the lob locator points to a temporary clob.
default void	open(LargeObjectAccessMode mode) Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to openLob(LargeObjectAccessMode), which provides the exact same behavior.
void	openLob(LargeObjectAccessMode mode) Open a CLOB in the indicated mode.
java.sql.SQLXML	toSQLXML() Returns an object which implements java.sql.SQLXML with content taken from this Clob.
java.sql.SQLXML	toSQLXML(java.lang.String schemaURL) Returns an object which implements java.sql.SQLXML with content taken from this Clob.

Methods inherited from interface java.sql.Clob

free, getAsciiStream, getCharacterStream, getCharacterStream, getSubString, length, position, position, setAsciiStream, setCharacterStream, setString, setString, truncate

Method Detail

open

@Deprecated
default void open(LargeObjectAccessMode mode)
                       throws java.sql.SQLException

Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to openLob(LargeObjectAccessMode), which provides the exact same behavior.

Open a CLOB in the indicated mode. Valid modes include MODE_READONLY, and MODE_READWRITE. It is an error to open the same LOB twice.

Throws:

java.sql.SQLException

Since:

8.2.0

openLob

void openLob(LargeObjectAccessMode mode)
      throws java.sql.SQLException

Open a CLOB in the indicated mode. Valid modes include MODE_READONLY, and MODE_READWRITE. It is an error to open the same LOB twice.

Throws:

java.sql.SQLException

Since:

23.5

close

@Deprecated
default void close()
                        throws java.sql.SQLException

Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to closeLob(), which provides the exact same behavior.

Close a previously opened CLOB.

Throws:

java.sql.SQLException

Since:

8.2.0

closeLob

void closeLob()
       throws java.sql.SQLException

Close a previously opened CLOB.

Throws:

java.sql.SQLException

Since:

23.5

isOpen

@Deprecated
default boolean isOpen()
                            throws java.sql.SQLException

Deprecated. The name of this method is anticipated to conflict with a future version of the JDBC Specification. This method will be removed in a future version of the Oracle JDBC Driver. Any calls to this method should be replaced with a call to isOpenLob(), which provides the exact same behavior.

Check whether the CLOB is opened.

Returns:

true if the LOB is opened.

Throws:

java.sql.SQLException

Since:

8.2.0

isOpenLob

boolean isOpenLob()
           throws java.sql.SQLException

Check whether the CLOB is opened.

Returns:

true if the LOB is opened.

Throws:

java.sql.SQLException

Since:

23.5

isTemporary

boolean isTemporary()
             throws java.sql.SQLException

Return true if the lob locator points to a temporary clob. False if it does not.

Returns:

true if the lob locator points to a temporary clob. False if it does not.

Throws:

java.sql.SQLException

Since:

8.2.0

isEmptyLob

boolean isEmptyLob()
            throws java.sql.SQLException

Return true if this is an empty lob.

Returns:

true if this is an empty lob.

Throws:

java.sql.SQLException

Since:

8.1.7

isSecureFile

boolean isSecureFile()
              throws java.sql.SQLException

Returns true if this is a SecureFile (LOBs with the STORE AS SECUREFILE option, which were introduced in Oracle Database 11g Release 1).

Returns:

true if this is a SecureFile and false otherwise.

Throws:

java.sql.SQLException

toSQLXML

java.sql.SQLXML toSQLXML()
                  throws java.sql.SQLException

Returns an object which implements java.sql.SQLXML with content taken from this Clob.

Returns:

the new SQLXML object

Throws:

java.sql.SQLException

Since:

12.2

toSQLXML

java.sql.SQLXML toSQLXML(java.lang.String schemaURL)
                  throws java.sql.SQLException

Returns an object which implements java.sql.SQLXML with content taken from this Clob.

Returns:

the new SQLXML object

Throws:

java.sql.SQLException

Since:

12.2