rowset/serial/SerialClob.java

36  * The <code>SerialClob</code> class provides a constructor for creating
39  * to the client before a <code>SerialClob</code> object
43  * <code>SerialClob</code> methods make it possible to get a substring
44  * from a <code>SerialClob</code> object or to locate the start of
49  * <p> A SerialClob is not safe for use by multiple concurrent threads.  If a
50  * SerialClob is to be used by more than one thread then access to the SerialClob
56 public class SerialClob implements Clob, Serializable, Cloneable {
60      * <code>CLOB</code> value that this <code>SerialClob</code> object
68      * Internal Clob representation if SerialClob is initialized with a
69      * Clob. Null if SerialClob is initialized with a char[].
74      * The length in characters of this <code>SerialClob</code> object's
82      * The original length in characters of this <code>SerialClob</code>
90      * Constructs a <code>SerialClob</code> object that is a serialized version of
93      * The new <code>SerialClob</code> object is initialized with the data from the
103     public SerialClob(char ch[]) throws SerialException, SQLException {
119      * Constructs a <code>SerialClob</code> object that is a serialized
122      * The new <code>SerialClob</code> object is initialized with the
126      * the database. Otherwise, the new <code>SerialClob</code> object
131      * and <code>Clob.getAsciiStream</code> methods. This <code>SerialClob</code>
136      *     <code>SerialClob</code> object is to be constructed; cannot be null
144     public SerialClob(Clob clob) throws SerialException, SQLException {
147             throw new SQLException("Cannot instantiate a SerialClob " +
178             throw new SerialException("SerialClob: " + ex.getMessage());
185      * Retrieves the number of characters in this <code>SerialClob</code>
189      *         <code>SerialClob</code> object's array of character
199      * Returns this <code>SerialClob</code> object's data as a stream
201      * a stream is produced regardless of whether the <code>SerialClob</code> object
205      *         <code>SerialClob</code> object's data
215      * Retrieves the <code>CLOB</code> value designated by this <code>SerialClob</code>
218      * <code>SerialClob</code> object is instantiated with a <code>Clob</code>
219      * object. If this <code>SerialClob</code> object is instantiated with
223      *     this <code>SerialClob</code> object's data
224      * @throws SerialException if this {@code SerialClob} object was not
229      * that was used to create this <code>SerialClob</code> object
236             throw new SerialException("Unsupported operation. SerialClob cannot " +
244      * <code>SerialClob</code> object, starting at the given position
249      *            <code>SerialClob</code> object is at position
253      *            <code>SerialClob</code> object
256      *               this <code>SerialClob</code> object, and the
259      *               <code>SerialClob</code> object
261      *         this <code>SerialClob</code> object beginning at the
271             throw new SerialException("Invalid position in SerialClob object set");
289      * Returns the position in this <code>SerialClob</code> object
296      * @param start the position in this <code>SerialClob</code> object
299      *         greater than the length of this <code>SerialClob</code> object
338      * Returns the position in this <code>SerialClob</code> object
344      * @param start the position in this <code>SerialClob</code> object
347      *         greater than the length of this <code>SerialClob</code> object
349      *         object begins in this <code>SerialClob</code> object,
364      * value that this <code>SerialClob</code> object represents, at the position
368      *         value that this <code>SerialClob</code> object represents; the first
370      *         greater than the length of this <code>SerialClob</code> object
372      *        value that this <code>SerialClob</code> object represents
377      *     is greater than the <code>SerialClob</code> length; or the combined
391      *         value that this <code>SerialClob</code> object represents; the first
393      *         greater than the length of this <code>SerialClob</code> object
403      *     is greater than the <code>SerialClob</code> length; or the combined
442      * <code>CLOB</code> value that this <code>SerialClob</code> object represents,
445      * the event that this <code>SerialClob</code> object is instantiated with a
446      * <code>Clob</code> object. If this <code>SerialClob</code> object is instantiated
452      * @throws SerialException if SerialClob is not instantiated with a
465              throw new SerialException("Unsupported operation. SerialClob cannot " +
473      * to the <code>CLOB</code> value that this <code>SerialClob</code> object
476      * object in the event that this <code>SerialClob</code> object is instantiated with a
477      * <code>Clob</code> object. If this <code>SerialClob</code> object is instantiated with
484      * @throws SerialException if the SerialClob is not instantiated with
497             throw new SerialException("Unsupported operation. SerialClob cannot " +
504      * Truncates the <code>CLOB</code> value that this <code>SerialClob</code>
508      * Truncating a <code>SerialClob</code> object to length 0 has the effect of
537      * {@code SerialClob} value, starting
541      * be retrieved.  The first character in the {@code SerialClob} is at position 1.
543      * @return {@code Reader} through which the partial {@code SerialClob}
546      * number of characters in the {@code SerialClob} or if pos + length
547      * is greater than the number of characters in the {@code SerialClob};
568      * This method frees the {@code SerialClob} object and releases the
590      * Compares this SerialClob to the specified object.  The result is {@code
592      * SerialClob} object that represents the same sequence of characters as this
595      * @param  obj The object to compare this {@code SerialClob} against
597      * @return  {@code true} if the given object represents a {@code SerialClob}
598      *          equivalent to this SerialClob, {@code false} otherwise
605         if (obj instanceof SerialClob) {
606             SerialClob sc = (SerialClob)obj;
615      * Returns a hash code for this {@code SerialClob}.
623      * Returns a clone of this {@code SerialClob}. The copy will contain a
625      * to the original internal character array of this {@code SerialClob} object.
628      * @return  a clone of this SerialClob
632             SerialClob sc = (SerialClob) super.clone();
643      * readObject is called to restore the state of the SerialClob from
662      * writeObject is called to save the state of the SerialClob
687                     + "SerialClob instance once free() has been called.");
692      * The identifier that assists in the serialization of this {@code SerialClob}