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/AbstractBlob.html | 523 +++++++++++++++++++ apidocs/com/amazon/carbonado/lob/AbstractClob.html | 406 +++++++++++++++ apidocs/com/amazon/carbonado/lob/Blob.html | 564 +++++++++++++++++++++ apidocs/com/amazon/carbonado/lob/BlobClob.html | 482 ++++++++++++++++++ .../com/amazon/carbonado/lob/ByteArrayBlob.html | 487 ++++++++++++++++++ .../com/amazon/carbonado/lob/CharArrayClob.html | 509 +++++++++++++++++++ apidocs/com/amazon/carbonado/lob/Clob.html | 447 ++++++++++++++++ apidocs/com/amazon/carbonado/lob/FileBlob.html | 468 +++++++++++++++++ apidocs/com/amazon/carbonado/lob/Lob.html | 249 +++++++++ apidocs/com/amazon/carbonado/lob/StringClob.html | 516 +++++++++++++++++++ .../carbonado/lob/class-use/AbstractBlob.html | 167 ++++++ .../carbonado/lob/class-use/AbstractClob.html | 174 +++++++ .../com/amazon/carbonado/lob/class-use/Blob.html | 379 ++++++++++++++ .../amazon/carbonado/lob/class-use/BlobClob.html | 117 +++++ .../carbonado/lob/class-use/ByteArrayBlob.html | 117 +++++ .../carbonado/lob/class-use/CharArrayClob.html | 117 +++++ .../com/amazon/carbonado/lob/class-use/Clob.html | 362 +++++++++++++ .../amazon/carbonado/lob/class-use/FileBlob.html | 117 +++++ .../com/amazon/carbonado/lob/class-use/Lob.html | 251 +++++++++ .../amazon/carbonado/lob/class-use/StringClob.html | 117 +++++ .../com/amazon/carbonado/lob/package-frame.html | 32 ++ .../com/amazon/carbonado/lob/package-summary.html | 234 +++++++++ apidocs/com/amazon/carbonado/lob/package-tree.html | 151 ++++++ apidocs/com/amazon/carbonado/lob/package-use.html | 293 +++++++++++ 24 files changed, 7279 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/lob/AbstractBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/AbstractClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Blob.html create mode 100644 apidocs/com/amazon/carbonado/lob/BlobClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/CharArrayClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Clob.html create mode 100644 apidocs/com/amazon/carbonado/lob/FileBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Lob.html create mode 100644 apidocs/com/amazon/carbonado/lob/StringClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Blob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Clob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Lob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/StringClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-use.html (limited to 'apidocs/com/amazon/carbonado/lob') diff --git a/apidocs/com/amazon/carbonado/lob/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html new file mode 100644 index 0000000..0764636 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html @@ -0,0 +1,523 @@ + + + + + + +AbstractBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class AbstractBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    Direct Known Subclasses:
    +
    ByteArrayBlob, FileBlob
    +
    +
    +
    +
    public abstract class AbstractBlob
+extends java.lang.Object
+implements Blob
    +
    AbstractBlob implements a small set of common Blob methods.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractBlob() 
      protected AbstractBlob(Repository repo) +
      Use of this constructor indicates that setValue should operate within a + transaction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.
      +
      java.lang.StringasString(java.nio.charset.Charset charset) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      java.lang.StringasString(java.lang.String charsetName) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      inthashCode() 
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.
      +
      voidsetValue(java.lang.String value, + java.nio.charset.Charset charset) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      voidsetValue(java.lang.String value, + java.lang.String charsetName) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractBlob

        +
        protected AbstractBlob()
        +
        • +
      + + + +
        +
      • +

        AbstractBlob

        +
        protected AbstractBlob(Repository repo)
        +
        Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.
        +
        Parameters:
        repo - optional repository to use for performing string conversion + within transactions
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString(java.lang.String charsetName)
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Parameters:
        charsetName - name of character set to decode String
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString(java.nio.charset.Charset charset)
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Parameters:
        charset - character set to decode String
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value,
+            java.lang.String charsetName)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        charsetName - name of character set to encode String
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value,
+            java.nio.charset.Charset charset)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        charset - character set to encode String
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Description copied from interface: Lob
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Specified by:
        +
        equals in interface Lob
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/AbstractClob.html new file mode 100644 index 0000000..75110e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractClob.html @@ -0,0 +1,406 @@ + + + + + + +AbstractClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class AbstractClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    Direct Known Subclasses:
    +
    BlobClob, CharArrayClob, StringClob
    +
    +
    +
    +
    public abstract class AbstractClob
+extends java.lang.Object
+implements Clob
    +
    AbstractClob implements a small set of common Clob methods.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractClob() 
      protected AbstractClob(Repository repo) +
      Use of this constructor indicates that setValue should operate within a + transaction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      inthashCode() 
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Clob data with the value of a single + String.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractClob

        +
        protected AbstractClob()
        +
        • +
      + + + +
        +
      • +

        AbstractClob

        +
        protected AbstractClob(Repository repo)
        +
        Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.
        +
        Parameters:
        repo - optional repository to use for performing string conversion + within transactions
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        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.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Clob
        +
        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.
        +
        +
        Specified by:
        +
        setValue in interface Clob
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Description copied from interface: Lob
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Specified by:
        +
        equals in interface Lob
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/Blob.html b/apidocs/com/amazon/carbonado/lob/Blob.html new file mode 100644 index 0000000..40d1dc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Blob.html @@ -0,0 +1,564 @@ + + + + + + +Blob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Blob

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Lob
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractBlob, ByteArrayBlob, FileBlob
    +
    +
    +
    +
    public interface Blob
+extends Lob
    +
    Provides access to BLOBs, which are Binary Large OBjects. Consider accessing + Blobs within a transaction scope, + to prevent unexpected updates.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Clob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.
      +
      java.lang.StringasString(java.nio.charset.Charset charset) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      java.lang.StringasString(java.lang.String charsetName) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.
      +
      voidsetValue(java.lang.String value, + java.nio.charset.Charset charset) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      voidsetValue(java.lang.String value, + java.lang.String charsetName) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

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

        openInputStream

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

        openInputStream

        +
        java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
+                                    throws FetchException
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream 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 Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        java.lang.String asString(java.lang.String charsetName)
+                          throws FetchException
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        Parameters:
        charsetName - name of character set to decode String
        +
        Throws:
        +
        java.nio.charset.IllegalCharsetNameException - if the given charset name is illegal
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        java.lang.String asString(java.nio.charset.Charset charset)
+                          throws FetchException
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        Parameters:
        charset - character set to decode String
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

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

        openOutputStream

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

        openOutputStream

        +
        java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
+                                      throws PersistException
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream 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 Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if length is negative
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.
        +
        Parameters:
        value - Blob is overwritten with this value
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value,
+            java.lang.String charsetName)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        Parameters:
        value - Blob is overwritten with this value
        charsetName - name of character set to encode String
        +
        Throws:
        +
        java.nio.charset.IllegalCharsetNameException - if the given charset name is illegal
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value,
+            java.nio.charset.Charset charset)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        Parameters:
        value - Blob is overwritten with this value
        charset - character set to encode String
        +
        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.

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
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()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html new file mode 100644 index 0000000..0a3f8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html @@ -0,0 +1,487 @@ + + + + + + +ByteArrayBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class ByteArrayBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    +
    public class ByteArrayBlob
+extends AbstractBlob
    +
    Implementation of a Blob which is backed by a growable in-memory byte array.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ByteArrayBlob(byte[] data) +
      Construct a ByteArrayBlob initially backed by the given byte array.
      +
      ByteArrayBlob(byte[] data, + int length) +
      Construct a ByteArrayBlob initially backed by the given byte array.
      +
      ByteArrayBlob(int capacity) +
      Construct a ByteArrayBlob with the given initial capacity.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(int capacity)
        +
        Construct a ByteArrayBlob with the given initial capacity.
        +
        Parameters:
        capacity - initial capacity of internal byte array
        +
        • +
      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(byte[] data)
        +
        Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Blob
        +
        • +
      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(byte[] data,
+             int length)
        +
        Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Blob
        length - initial length of data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream()
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos)
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +
        Description copied from interface: Blob
        +
        Returns the length of this Blob, in bytes.
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream()
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos)
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Blob
        +
        Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html new file mode 100644 index 0000000..7e24d4a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html @@ -0,0 +1,509 @@ + + + + + + +CharArrayClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class CharArrayClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class CharArrayClob
+extends AbstractClob
    +
    Implementation of a Clob which is backed by a growable in-memory character + array.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CharArrayClob(char[] data) +
      Construct a CharArrayClob initially backed by the given character array.
      +
      CharArrayClob(char[] data, + int length) +
      Construct a CharArrayClob initially backed by the given character array.
      +
      CharArrayClob(int capacity) +
      Construct a CharArrayClob with the given initial capacity.
      +
      +
      • +
    + +
      +
    • + + +

      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.lang.ObjectgetLocator() +
      Always returns null.
      +
      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

      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(int capacity)
        +
        Construct a CharArrayClob with the given initial capacity.
        +
        Parameters:
        capacity - initial capacity of internal character array
        +
        • +
      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(char[] data)
        +
        Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Clob
        +
        • +
      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(char[] data,
+             int length)
        +
        Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Clob
        length - initial length of data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
        +
        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
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos)
        +
        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
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos,
+                        int bufferSize)
        +
        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
        +
        • +
      + + + +
        +
      • +

        getLength

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

        asString

        +
        public java.lang.String asString()
        +
        Description copied from interface: Clob
        +
        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.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Overrides:
        +
        asString in class AbstractClob
        +
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter()
        +
        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
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos)
        +
        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
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos,
+                        int bufferSize)
        +
        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
        +
        • +
      + + + +
        +
      • +

        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()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + 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.

+ + diff --git a/apidocs/com/amazon/carbonado/lob/FileBlob.html b/apidocs/com/amazon/carbonado/lob/FileBlob.html new file mode 100644 index 0000000..4f41f03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/FileBlob.html @@ -0,0 +1,468 @@ + + + + + + +FileBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class FileBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    +
    public class FileBlob
+extends AbstractBlob
    +
    Implementation of a Blob which is backed by a File.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FileBlob(java.io.File file) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FileBlob

        +
        public FileBlob(java.io.File file)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream()
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos)
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLength

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

        openOutputStream

        +
        public java.io.OutputStream openOutputStream()
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos)
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream 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: Blob
        +
        Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/Lob.html b/apidocs/com/amazon/carbonado/lob/Lob.html new file mode 100644 index 0000000..69e3d8e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Lob.html @@ -0,0 +1,249 @@ + + + + + + +Lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Lob

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      java.lang.ObjectgetLocator() +
      Returns an object which identifies the Lob data, which may be null if + not supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocator

        +
        java.lang.Object getLocator()
        +
        Returns an object which identifies the Lob data, which may be null if + not supported.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        equals

        +
        boolean equals(java.lang.Object obj)
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/StringClob.html b/apidocs/com/amazon/carbonado/lob/StringClob.html new file mode 100644 index 0000000..6a2a54e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/StringClob.html @@ -0,0 +1,516 @@ + + + + + + +StringClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class StringClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class StringClob
+extends AbstractClob
    +
    Implementation of a Clob which is backed by a read-only String.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StringClob(java.lang.String str) 
      +
      • +
    + +
      +
    • + + +

      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.lang.ObjectgetLocator() +
      Always returns null.
      +
      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.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StringClob

        +
        public StringClob(java.lang.String str)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
        +
        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
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        Description copied from interface: Clob
        +
        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.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Overrides:
        +
        asString in class AbstractClob
        +
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Clob
        +
        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.
        +
        +
        Specified by:
        +
        setValue in interface Clob
        +
        Overrides:
        +
        setValue in class AbstractClob
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html new file mode 100644 index 0000000..c426a4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html @@ -0,0 +1,167 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.AbstractBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.AbstractBlob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html new file mode 100644 index 0000000..9764bbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html @@ -0,0 +1,174 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.AbstractClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.AbstractClob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Blob.html b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html new file mode 100644 index 0000000..9419f63 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html @@ -0,0 +1,379 @@ + + + + + + +Uses of Interface com.amazon.carbonado.lob.Blob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.lob.Blob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html new file mode 100644 index 0000000..258d0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.BlobClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.BlobClob

+
+
No usage of com.amazon.carbonado.lob.BlobClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html new file mode 100644 index 0000000..955f5b9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.ByteArrayBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.ByteArrayBlob

+
+
No usage of com.amazon.carbonado.lob.ByteArrayBlob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html new file mode 100644 index 0000000..1b6cadf --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.CharArrayClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.CharArrayClob

+
+
No usage of com.amazon.carbonado.lob.CharArrayClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Clob.html b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html new file mode 100644 index 0000000..04b5b7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html @@ -0,0 +1,362 @@ + + + + + + +Uses of Interface com.amazon.carbonado.lob.Clob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.lob.Clob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html new file mode 100644 index 0000000..a78da2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.FileBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.FileBlob

+
+
No usage of com.amazon.carbonado.lob.FileBlob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Lob.html b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html new file mode 100644 index 0000000..d632b81 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html @@ -0,0 +1,251 @@ + + + + + + +Uses of Interface com.amazon.carbonado.lob.Lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.lob.Lob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html new file mode 100644 index 0000000..ff9db45 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.StringClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.StringClob

+
+
No usage of com.amazon.carbonado.lob.StringClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-frame.html b/apidocs/com/amazon/carbonado/lob/package-frame.html new file mode 100644 index 0000000..5cd4200 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.lob

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html new file mode 100644 index 0000000..93d2196 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-summary.html @@ -0,0 +1,234 @@ + + + + + + +com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.lob

+
+
Support for LOB property types, which are Large OBjects.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.lob Description

+
Support for LOB property types, which are Large OBjects. Properties declared + as Blob or Clob are treated differently than regular + properties. In particular: + +
    +
  • Repository typically stores LOB data external from enclosing storable +
  • LOBs are accessed in a manner similar to how files are accessed +
  • LOB data is often read/written in chunks, so consider accessing in a transaction scope +
  • LOBs cannot be annotated with PrimaryKey, Key, Index, Join, + Version, or Sequence +
  • LOBs cannot be used in a query filter +
+ +

Also, setting a LOB property does not dirty that property unless the new + LOB is unequal. Updating a LOB property typically involves operating on the + LOB itself. Setting the LOB property again is useful only when completely + replacing the data, which can be a relatively expensive operation. + +

Some repositories require that large text data be stored as a LOB. If the + text property is intended to fit entirely in memory, consider defining the + property as a String instead of a LOB. This allows the repository to decide + if it is appropriate to store it as a LOB. If explicit control over charset + encoding is required, add a TextAdapter annotation.

+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-tree.html b/apidocs/com/amazon/carbonado/lob/package-tree.html new file mode 100644 index 0000000..8300746 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +com.amazon.carbonado.lob Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.lob

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-use.html b/apidocs/com/amazon/carbonado/lob/package-use.html new file mode 100644 index 0000000..20b3ebe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-use.html @@ -0,0 +1,293 @@ + + + + + + +Uses of Package com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.lob

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3