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

Annotation Type TextAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={java.lang.String.class,Clob.class,Blob.class})
+public @interface TextAdapter
    +
    Converts database Blobs and Clobs to Strings. This is suitable for text + values which are expected to fit entirely in memory. The storage layer will + attempt to store the text as a regular string, but will use a blob type if + required to. + +

    Example:

    + public interface UserInfo extends Storable {
+     @TextAdapter(charset="UTF-8")
+     String getWelcomeMessage();
+     void setWelcomeMessage(String message);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Clob, +Blob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]altCharsets +
      Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
      +
      java.lang.Stringcharset +
      Optionally specify a character set, which is used if the storage type is + a Blob.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        charset

        +
        public abstract java.lang.String charset
        +
        Optionally specify a character set, which is used if the storage type is + a Blob.
        +
        +
        Default:
        +
        "UTF-8"
        +
        +
        • +
      + + + +
        +
      • +

        altCharsets

        +
        public abstract java.lang.String[] altCharsets
        +
        Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3