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

Class GenericStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    Direct Known Subclasses:
    +
    CompressedStorableCodecFactory
    +
    +
    +
    +
    public class GenericStorableCodecFactory
+extends java.lang.Object
+implements StorableCodecFactory
    +
    Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenericStorableCodecFactory

        +
        public GenericStorableCodecFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        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, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout,
+                                                       RawSupport support)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        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, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex,
+                                                             LayoutOptions options)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        options - additional layout options (optional)
        +
        Throws:
        +
        SupportException
        Since:
        +
        1.2.1
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3