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 --- .../amazon/carbonado/raw/StorableCodecFactory.html | 291 +++++++++++++++++++++ 1 file changed, 291 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html (limited to 'apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html') diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html new file mode 100644 index 0000000..9a19a87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html @@ -0,0 +1,291 @@ + + + + + + +StorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface StorableCodecFactory

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

      Method Detail

      + + + +
        +
      • +

        getStorageName

        +
        java.lang.String getStorageName(java.lang.Class<? extends Storable> type)
+                                throws SupportException
        +
        Returns the preferred storage/database name for the given type. Return + null to let repository decide.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        getLayoutOptions

        +
        LayoutOptions getLayoutOptions(java.lang.Class<? extends Storable> type)
        +
        Optionally return additional information regarding storable encoding.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout,
+                                                RawSupport support)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3