| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.sql; |
| 27 | |
| 28 | import java.sql.Clob; |
| 29 | |
| 30 | /** |
| 31 | * The mapping in the Java<sup><font size=-2>TM</font></sup> programming language |
| 32 | * for the SQL <code>NCLOB</code> type. |
| 33 | * An SQL <code>NCLOB</code> is a built-in type |
| 34 | * that stores a Character Large Object using the National Character Set |
| 35 | * as a column value in a row of a database table. |
| 36 | * <P>The <code>NClob</code> interface extends the <code>Clob</code> interface |
| 37 | * which provides provides methods for getting the |
| 38 | * length of an SQL <code>NCLOB</code> value, |
| 39 | * for materializing a <code>NCLOB</code> value on the client, and for |
| 40 | * searching for a substring or <code>NCLOB</code> object within a |
| 41 | * <code>NCLOB</code> value. A <code>NClob</code> object, just like a <code>Clob</code> object, is valid for the duration |
| 42 | * of the transaction in which it was created. |
| 43 | * Methods in the interfaces {@link ResultSet}, |
| 44 | * {@link CallableStatement}, and {@link PreparedStatement}, such as |
| 45 | * <code>getNClob</code> and <code>setNClob</code> allow a programmer to |
| 46 | * access an SQL <code>NCLOB</code> value. In addition, this interface |
| 47 | * has methods for updating a <code>NCLOB</code> value. |
| 48 | * <p> |
| 49 | * All methods on the <code>NClob</code> interface must be fully implemented if the |
| 50 | * JDBC driver supports the data type. |
| 51 | * |
| 52 | * @since 1.6 |
| 53 | */ |
| 54 | |
| 55 | public interface NClob extends Clob { } |