Initial Checkin

1 files changed, 130 insertions, 0 deletions

diff --git a/java/sql/Clob.java b/java/sql/Clob.java
new file mode 100644
index 000000000..0ad2dabe8
--- /dev/null
+++ b/java/sql/Clob.java
@@ -0,0 +1,130 @@
+/*************************************************************************
+/* Clob.java -- Access Character Large OBjects
+/*
+/* Copyright (c) 1999 Free Software Foundation, Inc.
+/* Written by Aaron M. Renn (arenn@urbanophile.com)
+/*
+/* This library is free software; you can redistribute it and/or modify
+/* it under the terms of the GNU Library General Public License as published 
+/* by the Free Software Foundation, either version 2 of the License, or
+/* (at your option) any later verion.
+/*
+/* This library 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 Library General Public License for more details.
+/*
+/* You should have received a copy of the GNU Library General Public License
+/* along with this library; if not, write to the Free Software Foundation
+/* Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA
+/*************************************************************************/
+
+package java.sql;
+
+import java.io.InputStream;
+import java.io.Reader;
+
+/**
+  * This interface contains methods for accessing a SQL CLOB (Character
+  * Large OBject) type.
+  *
+  * @author Aaron M. Renn (arenn@urbanophile.com)
+  */
+public abstract interface Clob
+{
+
+/**
+  * This method returns the number of characters in the CLOB.
+  *
+  * @return The number of characters in the CLOB.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract long
+length() throws SQLException;
+
+/*************************************************************************/
+
+/**
+  * This method returns the specified portion of the CLOB as a 
+  * <code>String</code>. 
+  *
+  * @param offset The index into the CLOB (index values start at 1) to 
+  * start returning characters from.
+  * @param length The requested number of characters to return.
+  *
+  * @return The requested CLOB section, as a <code>String</code>.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract String
+getSubString(long offset, int length) throws SQLException;
+
+/*************************************************************************/
+
+/**
+  * This method returns a byte stream that reads the contents of the
+  * CLOB as a series of ASCII bytes.
+  *
+  * @return A stream to read the CLOB's contents.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract InputStream
+getAsciiStream() throws SQLException;
+
+/*************************************************************************/
+
+/**
+  * This method returns a character stream that reads the contents of the
+  * CLOB.
+  *
+  * @return A character stream to read the CLOB's contents.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract Reader
+getCharacterStream() throws SQLException;
+
+/*************************************************************************/
+
+/**
+  * This method returns the index into the CLOB of the first occurrence of
+  * the specified character pattern (supplied by the caller as a
+  * <code>String</code>).  The search begins at the specified index.
+  *
+  * @param pattern The character pattern to search for, passed as a
+  * <code>String</code>.
+  * @param offset.  The index into the CLOB to start search (indexes start
+  * at 1).
+  *
+  * @return The index at which the pattern was found (indexes start at 1),
+  * or -1 if the pattern was not found.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract long
+position(String pattern, long offset) throws SQLException;
+
+/*************************************************************************/
+
+/**
+  * This method returns the index into the CLOB of the first occurrence of
+  * the specified character pattern (supplied by the caller as a
+  * <code>Clob</code>).  The search begins at the specified index.
+  *
+  * @param pattern The character pattern to search for, passed as a
+  * <code>Clob</code>.
+  * @param offset.  The index into the CLOB to start search (indexes start
+  * at 1).
+  *
+  * @return The index at which the pattern was found (indexes start at 1),
+  * or -1 if the pattern was not found.
+  *
+  * @exception SQLException If an error occurs.
+  */
+public abstract long
+position(Clob pattern, long offset) throws SQLException;
+
+} // interface Clob
+