Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

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 Details

getAsciiStream

public InputStream getAsciiStream()
            throws SQLException
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()
            throws SQLException
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)
            throws SQLException
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()
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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)
            throws SQLException
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
Clob.java -- Access Character Large OBjects Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About