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/BlobClob.html | 482 +++++++++++++++++++++++++ 1 file changed, 482 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/lob/BlobClob.html (limited to 'apidocs/com/amazon/carbonado/lob/BlobClob.html') diff --git a/apidocs/com/amazon/carbonado/lob/BlobClob.html b/apidocs/com/amazon/carbonado/lob/BlobClob.html new file mode 100644 index 0000000..2b0adc3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/BlobClob.html @@ -0,0 +1,482 @@ + + + + + + +BlobClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.lob
+

Class BlobClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class BlobClob
    +extends AbstractClob
    +
    A Clob implementation which is backed by a Blob. Data is stored in the Blob + using UTF-16BE encoding.
    +
    Author:
    +
    Brian S O'Neill, Bob Loblaw
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      BlobClob(Blob blob) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.lang.ObjectgetLocator() +
      Returns an object which identifies the Lob data, which may be null if + not supported.
      +
      protected BlobgetWrappedBlob() 
      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.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlobClob

        +
        public BlobClob(Blob blob)
        +
        Parameters:
        blob - blob to wrap
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
        +                          throws FetchException
        +
        Description copied from interface: Clob
        +
        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:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos)
        +                          throws FetchException
        +
        Description copied from interface: Clob
        +
        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:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos,
        +                        int bufferSize)
        +                          throws FetchException
        +
        Description copied from interface: Clob
        +
        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:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +               throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns the length of this Clob, in characters.
        +
        Throws:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter()
        +                          throws PersistException
        +
        Description copied from interface: Clob
        +
        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:
        +
        PersistException
        +
      • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos)
        +                          throws PersistException
        +
        Description copied from interface: Clob
        +
        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:
        +
        PersistException
        +
      • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos,
        +                        int bufferSize)
        +                          throws PersistException
        +
        Description copied from interface: Clob
        +
        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:
        +
        PersistException
        +
      • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
        +               throws PersistException
        +
        Description copied from interface: Clob
        +
        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:
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
      • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Description copied from interface: Lob
        +
        Returns an object which identifies the Lob data, which may be null if + not supported.
        +
      • +
      + + + +
        +
      • +

        getWrappedBlob

        +
        protected Blob getWrappedBlob()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3