public interface Clob
An SQL CLOB type stores a large array of characters as the value in a
column of a database.
The java.sql.Clob interface provides methods for setting and
retrieving data in the Clob, for querying Clob data length,
for searching for data within the Clob.
| Modifier and Type | Method and Description |
|---|---|
void |
free()
Frees any resources held by this clob.
|
InputStream |
getAsciiStream()
Gets the value of this
Clob object as an ASCII stream. |
Reader |
getCharacterStream()
Gets the data of this
Clob object in a java.io.Reader. |
Reader |
getCharacterStream(long pos,
long length)
Returns a
Reader that reads length characters from this clob, starting
at 1-based offset {code pos}. |
String |
getSubString(long pos,
int length)
Gets a copy of a specified substring in this
Clob. |
long |
length()
Retrieves the number of characters in this
Clob object. |
long |
position(Clob searchstr,
long start)
Retrieves the character position at which a specified
Clob object
appears in this Clob object. |
long |
position(String searchstr,
long start)
Retrieves the character position at which a specified substring appears
in this
Clob object. |
OutputStream |
setAsciiStream(long pos)
Retrieves a stream which can be used to write Ascii characters to this
Clob object, starting at specified position. |
Writer |
setCharacterStream(long pos)
Retrieves a stream which can be used to write a stream of unicode
characters to this
Clob object, at a specified position. |
int |
setString(long pos,
String str)
Writes a given Java String to this
Clob object at a specified
position. |
int |
setString(long pos,
String str,
int offset,
int len)
Writes
len characters of a string, starting at a specified
character offset, to this Clob. |
void |
truncate(long len)
Truncates this
Clob after the specified number of characters. |
InputStream getAsciiStream() throws SQLException
Clob object as an ASCII stream.InputStream giving access to the
Clob data.SQLException - if an error occurs accessing the Clob.Reader getCharacterStream() throws SQLException
Clob object in a java.io.Reader.Clob data.SQLException - if an error occurs accessing the Clob.String getSubString(long pos, int length) throws SQLException
Clob.pos - the index of the start of the substring in the Clob.length - the length of the data to retrieve.SQLException - if an error occurs accessing the Clob.long length()
throws SQLException
Clob object.Clob.SQLException - if an error occurs accessing the Clob.long position(Clob searchstr, long start) throws SQLException
Clob object
appears in this Clob object.searchstr - the specified Clob to search for.start - the position within this Clob to start the searchClob occurs within this Clob.SQLException - if an error occurs accessing the Clob.long position(String searchstr, long start) throws SQLException
Clob object.searchstr - the string to search for.start - the position at which to start the search within this Clob.Clob.SQLException - if an error occurs accessing the Clob.OutputStream setAsciiStream(long pos) throws SQLException
Clob object, starting at specified position.pos - the position at which to start the writing.Clob.SQLException - if an error occurs accessing the Clob.Writer setCharacterStream(long pos) throws SQLException
Clob object, at a specified position.pos - the position at which to start the writing.Clob.SQLException - if an error occurs accessing the Clob.int setString(long pos,
String str)
throws SQLException
Clob object at a specified
position.pos - the position at which to start the writing.str - the string to write.SQLException - if an error occurs accessing the Clob.int setString(long pos,
String str,
int offset,
int len)
throws SQLException
len characters of a string, starting at a specified
character offset, to this Clob.pos - the position at which to start the writing.str - the String to write.offset - the offset within str to start writing from.len - the number of characters to write.SQLException - if an error occurs accessing the Clob.void truncate(long len)
throws SQLException
Clob after the specified number of characters.len - the length in characters giving the place to
truncate this Clob.SQLException - if an error occurs accessing the Clob.void free()
throws SQLException
free is called, calling
method other than free will throw SQLException (calling free
repeatedly will do nothing).SQLExceptionReader getCharacterStream(long pos, long length) throws SQLException
Reader that reads length characters from this clob, starting
at 1-based offset {code pos}.SQLException