jdk/src/share/classes/java/sql/NClob.java
author lancea
Mon, 11 Aug 2014 14:22:22 -0400
changeset 25976 4de01a56e3ee
parent 18564 f9db68ff2cbb
permissions -rw-r--r--
8054555: javadoc cleanup for java.sql and javax.sql Reviewed-by: darcy, igerasim
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
18564
f9db68ff2cbb 8017471: Fix JDBC -Xdoclint public errors
lancea
parents: 5506
diff changeset
     2
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.sql;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
18564
f9db68ff2cbb 8017471: Fix JDBC -Xdoclint public errors
lancea
parents: 5506
diff changeset
    29
 * The mapping in the Java™ programming language
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * for the SQL <code>NCLOB</code> type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * An SQL <code>NCLOB</code> is a built-in type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * that stores a Character Large Object using the National Character Set
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *  as a column value in a row of  a database table.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * <P>The <code>NClob</code> interface extends the <code>Clob</code> interface
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 18564
diff changeset
    35
 * which provides methods for getting the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * length of an SQL <code>NCLOB</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * for materializing a <code>NCLOB</code> value on the client, and for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * searching for a substring or <code>NCLOB</code> object within a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <code>NCLOB</code> value. A <code>NClob</code> object, just like a <code>Clob</code> object, is valid for the duration
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * of the transaction in which it was created.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * Methods in the interfaces {@link ResultSet},
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * {@link CallableStatement}, and {@link PreparedStatement}, such as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * <code>getNClob</code> and <code>setNClob</code> allow a programmer to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * access an SQL <code>NCLOB</code> value.  In addition, this interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * has methods for updating a <code>NCLOB</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * All methods on the <code>NClob</code> interface must be fully implemented if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * JDBC driver supports the data type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
public interface NClob extends Clob { }