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

Class MasterStorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public final class MasterStorableGenerator<S extends Storable>
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable types + suitable for use by master repositories. The generated classes extend those + generated by StorableGenerator. Subclasses need not worry about + transactions since this class takes care of that.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Olga Kuznetsova
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type, + java.util.EnumSet<MasterFeature> features) +
      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

      + + + +
        +
      • +

        DO_TRY_LOAD_MASTER_METHOD_NAME

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

        DO_TRY_INSERT_MASTER_METHOD_NAME

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

        DO_TRY_UPDATE_MASTER_METHOD_NAME

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

        DO_TRY_DELETE_MASTER_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_DELETE_MASTER_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,
+                                                                 java.util.EnumSet<MasterFeature> features)
+                                                                      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. The constructor for the returned abstract + class looks like this: + + 
        + public <init>(MasterSupport);
+
        + + Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 
        + // Load the object by examining the primary key.
+ protected abstract boolean doTryLoad() throws FetchException;
+
+ // Insert the object into the storage layer.
+ protected abstract boolean doTryInsert_master() throws PersistException;
+
+ // Update the object in the storage.
+ protected abstract boolean doTryUpdate_master() throws PersistException;
+
+ // Delete the object from the storage layer by the primary key.
+ protected abstract boolean doTryDelete_master() throws PersistException;
+
        + + Subclasses can access the MasterSupport instance via the protected field + named by SUPPORT_FIELD_NAME.
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        java.lang.IllegalArgumentException - if type is null
        +
        SupportException
        See Also:
        MasterSupport
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3