java.sql

Interface Clob

public interface Clob

This interface contains methods for accessing a SQL CLOB (Character Large OBject) type.

Method Summary
InputStream	getAsciiStream() This method returns a byte stream that reads the contents of this `Clob` as a series of ASCII bytes.
Reader	getCharacterStream() This method returns a character stream that reads the contents of this `Clob`.
String	getSubString(long start, int count) This method returns the specified portion of this `Clob` as a `String`.
long	length() This method returns the number of characters in this `Clob`.
long	position(String pattern, long start) This method returns the index into this `Clob` of the first occurrence of the specified character pattern (supplied by the caller as a `String`).
long	position(Clob pattern, long start) This method returns the index into this `Clob` of the first occurrence of the specified character pattern (supplied by the caller as a `Clob`).
OutputStream	setAsciiStream(long start) Returns an ASCII text stream that writes into this `Clob`, starting at the specified index.
Writer	setCharacterStream(long start) Returns a character stream that writes into this `Clob`, starting at the specified index.
int	setString(long start, String value) Writes the specified string into this `Clob`, starting at the specified index.
int	setString(long startWrite, String value, int startRead, int count) Writes the specified portion of a string into this `Clob`, starting at the specified index.
void	truncate(long count) Truncates this `Clob` to be at most the specified number of characters long.

Method Detail

getAsciiStream

public InputStream getAsciiStream()

This method returns a byte stream that reads the contents of this Clob as a series of ASCII bytes.

Returns: A stream to read this Clob's contents.

Throws: SQLException If an error occurs.

Since: 1.2

getCharacterStream

public Reader getCharacterStream()

This method returns a character stream that reads the contents of this Clob.

Returns: A character stream to read this Clob's contents.

Throws: SQLException If an error occurs.

Since: 1.2

getSubString

public String getSubString(long start, int count)

This method returns the specified portion of this Clob as a String.

Parameters: start The index into this Clob (index values start at 1) to start returning characters from. count The requested number of characters to return.

Returns: The requested Clob section, as a String.

Throws: SQLException If an error occurs.

Since: 1.2

length

public long length()

This method returns the number of characters in this Clob.

Returns: The number of characters in this Clob.

Throws: SQLException If an error occurs.

Since: 1.2

position

public long position(String pattern, long start)

This method returns the index into this Clob of the first occurrence of the specified character pattern (supplied by the caller as a String). The search begins at the specified index.

Parameters: pattern The character pattern to search for, passed as a String. start The index into this Clob to start searching (indices start at 1).

Returns: The index at which the pattern was found (indices start at 1), or -1 if the pattern was not found.

Throws: SQLException If an error occurs.

Since: 1.2

position

public long position(Clob pattern, long start)

This method returns the index into this Clob of the first occurrence of the specified character pattern (supplied by the caller as a Clob). The search begins at the specified index.

Parameters: pattern The character pattern to search for, passed as a Clob. start The index into this Clob to start searching (indices start at 1).

Returns: The index at which the pattern was found (indices start at 1), or -1 if the pattern was not found.

Throws: SQLException If an error occurs.

Since: 1.2

setAsciiStream

public OutputStream setAsciiStream(long start)

Returns an ASCII text stream that writes into this Clob, starting at the specified index.

Parameters: start The index at which the writing starts.

Returns: An ASCII text stream to write into this Clob.

Throws: SQLException If an error occurs.

Since: 1.4

setCharacterStream

public Writer setCharacterStream(long start)

Returns a character stream that writes into this Clob, starting at the specified index.

Parameters: start The index at which the writing starts.

Returns: A character stream to write into this Clob.

Throws: SQLException If an error occurs.

Since: 1.4

setString

public int setString(long start, String value)

Writes the specified string into this Clob, starting at the specified index.

Parameters: start The index at which the writing starts. value The string to write.

Returns: The number of characters written.

Throws: SQLException If an error occurs.

Since: 1.4

setString

public int setString(long startWrite, String value, int startRead, int count)

Writes the specified portion of a string into this Clob, starting at the specified index.

Parameters: startWrite The index at which the writing starts. value The string to write a portion of. startRead The offset into the string where the portion to copy starts. count The number of characters to write.

Returns: The number of characters written.

Throws: SQLException If an error occurs.

Since: 1.4

truncate

public void truncate(long count)

Truncates this Clob to be at most the specified number of characters long.

Parameters: count The length this Clob is truncated to.

Throws: SQLException If an error occurs.

Since: 1.4