From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- apidocs/com/amazon/carbonado/lob/Clob.html | 447 +++++++++++++++++++++++++++++ 1 file changed, 447 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/lob/Clob.html (limited to 'apidocs/com/amazon/carbonado/lob/Clob.html') diff --git a/apidocs/com/amazon/carbonado/lob/Clob.html b/apidocs/com/amazon/carbonado/lob/Clob.html new file mode 100644 index 0000000..f2e49a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Clob.html @@ -0,0 +1,447 @@ + + + + + + +Clob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Clob

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Lob
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractClob, BlobClob, CharArrayClob, StringClob
    +
    +
    +
    +
    public interface Clob
+extends Lob
    +
    Provides access to CLOBs, which are Character Large OBjects. Consider + accessing Clobs within a transaction scope, to prevent unexpected updates.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Blob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.io.ReaderopenReader() +
      Returns a Reader for reading Clob data, positioned at the start.
      +
      java.io.ReaderopenReader(long pos) +
      Returns a Reader for reading Clob data.
      +
      java.io.ReaderopenReader(long pos, + int bufferSize) +
      Returns a Reader for reading Clob data.
      +
      java.io.WriteropenWriter() +
      Returns a Writer for writing Clob data, positioned at the start.
      +
      java.io.WriteropenWriter(long pos) +
      Returns a Writer for writing Clob data.
      +
      java.io.WriteropenWriter(long pos, + int bufferSize) +
      Returns a Writer for writing Clob data.
      +
      voidsetLength(long length) +
      Set the length of this Clob, in characters.
      +
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Clob data with the value of a single + String.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader()
+                          throws FetchException
        +
        Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader(long pos)
+                          throws FetchException
        +
        Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader(long pos,
+                        int bufferSize)
+                          throws FetchException
        +
        Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the reader buffer be at least this large (in characters)
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + + + + + +
        +
      • +

        asString

        +
        java.lang.String asString()
+                          throws FetchException
        +
        Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if Clob length is greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Clob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter()
+                          throws PersistException
        +
        Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter(long pos)
+                          throws PersistException
        +
        Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter(long pos,
+                        int bufferSize)
+                          throws PersistException
        +
        Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the writer buffer be at least this large (in characters)
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        void setLength(long length)
+               throws PersistException
        +
        Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if length is negative
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value)
+              throws PersistException
        +
        Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3