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

Class RawStorableGenerator

+
+
+ +
+
    +
  • +
    +
    +
    public class RawStorableGenerator
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable types + which are encoded and decoded in a raw format. The generated abstract + classes extend those created by MasterStorableGenerator.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    GenericStorableCodec, +RawSupport
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringDECODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDECODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type, + boolean isMaster) +
      Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ENCODE_KEY_METHOD_NAME

        +
        public static final java.lang.String ENCODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_KEY_METHOD_NAME

        +
        public static final java.lang.String DECODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ENCODE_DATA_METHOD_NAME

        +
        public static final java.lang.String ENCODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_DATA_METHOD_NAME

        +
        public static final java.lang.String DECODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type,
+                                                                 boolean isMaster)
+                                                                      throws SupportException,
+                                                                             java.lang.IllegalArgumentException
        +
        Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. Three constructors are defined for the + abstract implementation: + + 
        + public <init>(RawSupport);
+
+ public <init>(RawSupport, byte[] key);
+
+ public <init>(RawSupport, byte[] key, byte[] value);
+
        + +

        Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 

        + // Encode the primary key of this storable.
+ protected abstract byte[] encodeKey();
+
+ // Encode all properties of this storable excluding the primary key.
+ protected abstract byte[] encodeData();
+
+ // Decode the primary key into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeKey(byte[]);
+
+ // Decode the data into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeData(byte[]);
+
        +
        Parameters:
        isMaster - when true, version properties, sequences, and triggers are managed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3