Added in API level 1

Clob

interface Clob
java.sql.Clob

The mapping in the JavaTM programming language for the SQL CLOB type. An SQL CLOB is a built-in type that stores a Character Large Object as a column value in a row of a database table. By default drivers implement a Clob object using an SQL locator(CLOB), which means that a Clob object contains a logical pointer to the SQL CLOB data rather than the data itself. A Clob object is valid for the duration of the transaction in which it was created.

The Clob interface provides methods for getting the length of an SQL CLOB (Character Large Object) value, for materializing a CLOB value on the client, and for searching for a substring or CLOB object within a CLOB value. Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement, such as getClob and setClob allow a programmer to access an SQL CLOB value. In addition, this interface has methods for updating a CLOB value.

All methods on the Clob interface must be fully implemented if the JDBC driver supports the data type.

Summary

Public methods
abstract Unit

This method frees the Clob object and releases the resources the resources that it holds.
abstract InputStream!

Retrieves the CLOB value designated by this Clob object as an ascii stream.
abstract Reader!

Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).
abstract Reader!
getCharacterStream(pos: Long, length: Long)

Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.
abstract String!
getSubString(pos: Long, length: Int)

Retrieves a copy of the specified substring in the CLOB value designated by this Clob object.
abstract Long

Retrieves the number of characters in the CLOB value designated by this Clob object.
abstract Long
position(searchstr: String!, start: Long)

Retrieves the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object.
abstract Long
position(searchstr: Clob!, start: Long)

Retrieves the character position at which the specified Clob object searchstr appears in this Clob object.
abstract OutputStream!

Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos.
abstract Writer!

Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos.
abstract Int
setString(pos: Long, str: String!)

Writes the given Java String to the CLOB value that this Clob object designates at the position pos.
abstract Int
setString(pos: Long, str: String!, offset: Int, len: Int)

Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.
abstract Unit
truncate(len: Long)

Truncates the CLOB value that this Clob designates to have a length of len characters.

Public methods

free

Added in API level 9
abstract fun free(): Unit

This method frees the Clob object and releases the resources the resources that it holds. The object is invalid once the free method is called.

After free has been called, any attempt to invoke a method other than free will result in a SQLException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op.

Exceptions
java.sql.SQLException if an error occurs releasing the Clob's resources
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

getAsciiStream

Added in API level 1
abstract fun getAsciiStream(): InputStream!

Retrieves the CLOB value designated by this Clob object as an ascii stream.

Return
InputStream! a java.io.InputStream object containing the CLOB data
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

See Also

getCharacterStream

Added in API level 1
abstract fun getCharacterStream(): Reader!

Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).

Return
Reader! a java.io.Reader object containing the CLOB data
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

getCharacterStream

Added in API level 9
abstract fun getCharacterStream(
    pos: Long, 
    length: Long
): Reader!

Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.

Parameters
pos Long: the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.
length Long: the length in characters of the partial value to be retrieved.
Return
Reader! Reader through which the partial Clob value can be read.
Exceptions
java.sql.SQLException if pos is less than 1 or if pos is greater than the number of characters in the Clob or if pos + length is greater than the number of characters in the Clob
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

getSubString

Added in API level 1
abstract fun getSubString(
    pos: Long, 
    length: Int
): String!

Retrieves a copy of the specified substring in the CLOB value designated by this Clob object. The substring begins at position pos and has up to length consecutive characters.

Parameters
pos Long: the first character of the substring to be extracted. The first character is at position 1.
length Int: the number of consecutive characters to be copied; the value for length must be 0 or greater
Return
String! a String that is the specified substring in the CLOB value designated by this Clob object
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value; if pos is less than 1 or length is less than 0
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

length

Added in API level 1
abstract fun length(): Long

Retrieves the number of characters in the CLOB value designated by this Clob object.

Return
Long length of the CLOB in characters
Exceptions
java.sql.SQLException if there is an error accessing the length of the CLOB value
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

position

Added in API level 1
abstract fun position(
    searchstr: String!, 
    start: Long
): Long

Retrieves the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object. The search begins at position start.

Parameters
searchstr String!: the substring for which to search
start Long: the position at which to begin searching; the first position is 1
Return
Long the position at which the substring appears or -1 if it is not present; the first position is 1
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value or if pos is less than 1
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

position

Added in API level 1
abstract fun position(
    searchstr: Clob!, 
    start: Long
): Long

Retrieves the character position at which the specified Clob object searchstr appears in this Clob object. The search begins at position start.

Parameters
searchstr Clob!: the Clob object for which to search
start Long: the position at which to begin searching; the first position is 1
Return
Long the position at which the Clob object appears or -1 if it is not present; the first position is 1
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value or if start is less than 1
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

setAsciiStream

Added in API level 1
abstract fun setAsciiStream(pos: Long): OutputStream!

Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accomodate the extra characters.

Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

Parameters
pos Long: the position at which to start writing to this CLOB object; The first position is 1
Return
OutputStream! the stream to which ASCII encoded characters can be written
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value or if pos is less than 1
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

See Also

setCharacterStream

Added in API level 1
abstract fun setCharacterStream(pos: Long): Writer!

Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accomodate the extra characters.

Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

Parameters
pos Long: the position at which to start writing to the CLOB value; The first position is 1
Return
Writer! a stream to which Unicode encoded characters can be written
Exceptions
java.sql.SQLException if there is an error accessing the CLOB value or if pos is less than 1
java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

See Also

    setString

    Added in API level 1
    abstract fun setString(
        pos: Long, 
        str: String!
    ): Int

    Writes the given Java String to the CLOB value that this Clob object designates at the position pos. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters.

    Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

    Parameters
    pos Long: the position at which to start writing to the CLOB value that this Clob object represents; The first position is 1
    str String!: the string to be written to the CLOB value that this Clob designates
    Return
    Int the number of characters written
    Exceptions
    java.sql.SQLException if there is an error accessing the CLOB value or if pos is less than 1
    java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

    setString

    Added in API level 1
    abstract fun setString(
        pos: Long, 
        str: String!, 
        offset: Int, 
        len: Int
    ): Int

    Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters.

    Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

    Parameters
    pos Long: the position at which to start writing to this CLOB object; The first position is 1
    str String!: the string to be written to the CLOB value that this Clob object represents
    offset Int: the offset into str to start reading the characters to be written
    len Int: the number of characters to be written
    Return
    Int the number of characters written
    Exceptions
    java.sql.SQLException if there is an error accessing the CLOB value or if pos is less than 1
    java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method

    truncate

    Added in API level 1
    abstract fun truncate(len: Long): Unit

    Truncates the CLOB value that this Clob designates to have a length of len characters.

    Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

    Parameters
    len Long: the length, in characters, to which the CLOB value should be truncated
    Exceptions
    java.sql.SQLException if there is an error accessing the CLOB value or if len is less than 0
    java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this method