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/gen/CodeBuilderUtil.html | 792 ++++++++++++++ .../amazon/carbonado/gen/CommonMethodNames.html | 1091 ++++++++++++++++++++ .../carbonado/gen/DelegateStorableGenerator.html | 245 +++++ .../com/amazon/carbonado/gen/DelegateSupport.html | 298 ++++++ .../carbonado/gen/DetachedStorableFactory.html | 267 +++++ .../com/amazon/carbonado/gen/MasterFeature.html | 501 +++++++++ .../carbonado/gen/MasterStorableGenerator.html | 363 +++++++ .../com/amazon/carbonado/gen/MasterSupport.html | 246 +++++ .../amazon/carbonado/gen/StorableCopier.From.html | 228 ++++ .../com/amazon/carbonado/gen/StorableCopier.html | 370 +++++++ .../amazon/carbonado/gen/StorableGenerator.html | 755 ++++++++++++++ .../amazon/carbonado/gen/StorablePropertyMap.html | 461 +++++++++ .../com/amazon/carbonado/gen/StorableSupport.html | 237 +++++ .../com/amazon/carbonado/gen/TriggerSupport.html | 326 ++++++ .../carbonado/gen/class-use/CodeBuilderUtil.html | 117 +++ .../carbonado/gen/class-use/CommonMethodNames.html | 117 +++ .../gen/class-use/DelegateStorableGenerator.html | 117 +++ .../carbonado/gen/class-use/DelegateSupport.html | 117 +++ .../gen/class-use/DetachedStorableFactory.html | 117 +++ .../carbonado/gen/class-use/MasterFeature.html | 193 ++++ .../gen/class-use/MasterStorableGenerator.html | 117 +++ .../carbonado/gen/class-use/MasterSupport.html | 213 ++++ .../gen/class-use/StorableCopier.From.html | 159 +++ .../carbonado/gen/class-use/StorableCopier.html | 159 +++ .../carbonado/gen/class-use/StorableGenerator.html | 117 +++ .../gen/class-use/StorablePropertyMap.html | 160 +++ .../carbonado/gen/class-use/StorableSupport.html | 225 ++++ .../carbonado/gen/class-use/TriggerSupport.html | 219 ++++ .../com/amazon/carbonado/gen/package-frame.html | 39 + .../com/amazon/carbonado/gen/package-summary.html | 249 +++++ apidocs/com/amazon/carbonado/gen/package-tree.html | 170 +++ apidocs/com/amazon/carbonado/gen/package-use.html | 250 +++++ 32 files changed, 9035 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html create mode 100644 apidocs/com/amazon/carbonado/gen/CommonMethodNames.html create mode 100644 apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/DelegateSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterFeature.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableCopier.From.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableCopier.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/TriggerSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-use.html (limited to 'apidocs/com/amazon/carbonado/gen') diff --git a/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html new file mode 100644 index 0000000..c20d420 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html @@ -0,0 +1,792 @@ + + + + + + +CodeBuilderUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class CodeBuilderUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class CodeBuilderUtil
    +extends java.lang.Object
    +
    Collection of useful utilities for generating Carbonado code.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CodeBuilderUtil() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddEqualsCall(org.cojen.classfile.CodeBuilder b, + java.lang.String fieldName, + org.cojen.classfile.TypeDesc fieldType, + boolean testForNull, + org.cojen.classfile.Label fail, + org.cojen.classfile.LocalVariable other) +
      Generates code to compare a field in this object against the same one in a + different instance.
      +
      static voidaddValueHashCodeCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + boolean mixIn) +
      Generates code to compute a hashcode for a value on the stack, consuming + the value.
      +
      static voidaddValuesEqualCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + org.cojen.classfile.Label label, + boolean choice) +
      Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal.
      +
      static voidassertParameterNotNull(org.cojen.classfile.CodeBuilder b, + int paramIndex) +
      Generate code to throw an exception if a parameter is null
      +
      static org.cojen.classfile.TypeDescbindQueryParam(java.lang.Class clazz) +
      Determines which overloaded "with" method on Query should be bound to.
      +
      static voidblankValue(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type) +
      Generates code to push a blank value to the stack.
      +
      static voidcallStringBuilderAppendChar(org.cojen.classfile.CodeBuilder b) +
      Appends a char to a StringBuilder.
      +
      static voidcallStringBuilderAppendString(org.cojen.classfile.CodeBuilder b) +
      Appends a String to a StringBuilder.
      +
      static voidcallStringBuilderLength(org.cojen.classfile.CodeBuilder b) +
      Calls length on a StringBuilder on the stack, leaving an int on the stack.
      +
      static voidcallStringBuilderSetLength(org.cojen.classfile.CodeBuilder b) +
      Calls setLength on a StringBuilder.
      +
      static voidcallStringBuilderToString(org.cojen.classfile.CodeBuilder b) +
      Calls toString on a StringBuilder.
      +
      static voidconvertValue(org.cojen.classfile.CodeBuilder b, + java.lang.Class from, + java.lang.Class to) +
      Converts a value on the stack.
      +
      static <S extends Storable
      org.cojen.classfile.ClassFile
      createStorableClassFile(org.cojen.util.ClassInjector ci, + java.lang.Class<S> type, + boolean isAbstract, + java.lang.String aSourcefileName) +
      Define a classfile appropriate for most Storables.
      +
      static voiddefineCopyBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf) +
      Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
      +
      static voiddefinePrepareBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf) +
      Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
      +
      static voiddefinePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType) +
      Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
      +
      static voiddefinePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType, + java.lang.String supportFieldName, + org.cojen.classfile.TypeDesc supportFieldType) +
      Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
      +
      static java.util.Set<java.lang.Class>gatherAllBridgeTypes(java.util.Set<java.lang.Class> set, + java.lang.Class leaf) +
      Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).
      +
      static voidincrementVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type) +
      Generates code to increment a version property value, already on the stack.
      +
      static voidinitialVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type, + int value) +
      Generates code to push an initial version property value on the stack.
      +
      static booleanisPublicMethodFinal(java.lang.Class clazz, + java.lang.String name, + org.cojen.classfile.TypeDesc retType, + org.cojen.classfile.TypeDesc[] params) +
      Returns true if a public final method exists which matches the given + specification.
      +
      static voidthrowConcatException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String... messages) +
      Generate code to throw an exception with a message concatenated at runtime.
      +
      static voidthrowException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String message) +
      Generate code to throw an exception with an optional message.
      +
      static org.cojen.classfile.LocalVariableuneraseGenericParameter(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc paramType, + int paramIndex) +
      Generate code to create a local variable containing the specified parameter coerced + to the specified type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CodeBuilderUtil

        +
        public CodeBuilderUtil()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        assertParameterNotNull

        +
        public static void assertParameterNotNull(org.cojen.classfile.CodeBuilder b,
        +                          int paramIndex)
        +
        Generate code to throw an exception if a parameter is null
        +
        Parameters:
        b - CodeBuilder into which to append the code
        paramIndex - index of the parameter to check
        +
      • +
      + + + +
        +
      • +

        uneraseGenericParameter

        +
        public static org.cojen.classfile.LocalVariable uneraseGenericParameter(org.cojen.classfile.CodeBuilder b,
        +                                                        org.cojen.classfile.TypeDesc paramType,
        +                                                        int paramIndex)
        +
        Generate code to create a local variable containing the specified parameter coerced + to the specified type. This is useful for re-interpreting erased generics into + the more specific genericized type.
        +
        Parameters:
        b - CodeBuilder into which to append the code
        paramType - the more specific type which was erased during compilation
        paramIndex - index of the parameter to unerase
        +
        Returns:
        a local variable referencing the type-cast parameter
        +
      • +
      + + + +
        +
      • +

        throwException

        +
        public static void throwException(org.cojen.classfile.CodeBuilder b,
        +                  java.lang.Class type,
        +                  java.lang.String message)
        +
        Generate code to throw an exception with an optional message.
        +
        Parameters:
        b - CodeBuilder to which to add code
        type - type of the object to throw
        message - optional message to provide to the constructor
        +
      • +
      + + + +
        +
      • +

        throwConcatException

        +
        public static void throwConcatException(org.cojen.classfile.CodeBuilder b,
        +                        java.lang.Class type,
        +                        java.lang.String... messages)
        +
        Generate code to throw an exception with a message concatenated at runtime.
        +
        Parameters:
        b - CodeBuilder to which to add code
        type - type of the object to throw
        messages - messages to concat at runtime
        +
      • +
      + + + +
        +
      • +

        gatherAllBridgeTypes

        +
        public static java.util.Set<java.lang.Class> gatherAllBridgeTypes(java.util.Set<java.lang.Class> set,
        +                                                  java.lang.Class leaf)
        +
        Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class). Eg, for Object, all + classes and implemented interfaces for every superclass between foo (the leaf) and + Object (the base). +

        A copy must be coercible into any of these types, and copy bridge methods must be + provided to do so. + +

        Note that the official documentation for this is in draft form, and you have to be + psychic to have figured out the necessity in the first place.

        +
        Parameters:
        set - set into which the class types will be collected
        leaf - leaf class
        +
        Returns:
        same set as was passed in
        +
      • +
      + + + +
        +
      • +

        defineCopyBridges

        +
        public static void defineCopyBridges(org.cojen.classfile.ClassFile cf,
        +                     java.lang.Class leaf)
        +
        Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
        +
        Parameters:
        cf - file to which to add the copy bridge
        leaf - leaf class
        +
      • +
      + + + +
        +
      • +

        definePrepareMethod

        +
        public static void definePrepareMethod(org.cojen.classfile.ClassFile cf,
        +                       java.lang.Class storableClass,
        +                       org.cojen.classfile.TypeDesc supportCtorType)
        +
        Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
        +
        Parameters:
        cf - file to which to add the prepare method
        Since:
        +
        1.2
        +
      • +
      + + + +
        +
      • +

        definePrepareMethod

        +
        public static void definePrepareMethod(org.cojen.classfile.ClassFile cf,
        +                       java.lang.Class storableClass,
        +                       org.cojen.classfile.TypeDesc supportCtorType,
        +                       java.lang.String supportFieldName,
        +                       org.cojen.classfile.TypeDesc supportFieldType)
        +
        Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
        +
        Parameters:
        cf - file to which to add the prepare method
        Since:
        +
        1.2
        +
      • +
      + + + +
        +
      • +

        definePrepareBridges

        +
        public static void definePrepareBridges(org.cojen.classfile.ClassFile cf,
        +                        java.lang.Class leaf)
        +
        Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
        +
        Parameters:
        cf - file to which to add the prepare bridge
        leaf - leaf class
        Since:
        +
        1.2
        +
      • +
      + + + +
        +
      • +

        isPublicMethodFinal

        +
        public static boolean isPublicMethodFinal(java.lang.Class clazz,
        +                          java.lang.String name,
        +                          org.cojen.classfile.TypeDesc retType,
        +                          org.cojen.classfile.TypeDesc[] params)
        +
        Returns true if a public final method exists which matches the given + specification.
        +
      • +
      + + + +
        +
      • +

        createStorableClassFile

        +
        public static <S extends Storable> org.cojen.classfile.ClassFile createStorableClassFile(org.cojen.util.ClassInjector ci,
        +                                                                         java.lang.Class<S> type,
        +                                                                         boolean isAbstract,
        +                                                                         java.lang.String aSourcefileName)
        +
        Define a classfile appropriate for most Storables. Specifically: +
          +
        • implements Storable
        • +
        • implements Cloneable +
        • abstract if appropriate +
        • marked synthetic +
        • targetted for java version 1.5 +
        +
        Parameters:
        ci - ClassInjector for the storable
        type - specific Storable implementation to generate
        isAbstract - true if the class should be abstract
        aSourcefileName - identifier for the classfile, typically the factory class name
        +
        Returns:
        ClassFile object ready to have methods added.
        +
      • +
      + + + +
        +
      • +

        addValueHashCodeCall

        +
        public static void addValueHashCodeCall(org.cojen.classfile.CodeBuilder b,
        +                        org.cojen.classfile.TypeDesc valueType,
        +                        boolean testForNull,
        +                        boolean mixIn)
        +
        Generates code to compute a hashcode for a value on the stack, consuming + the value. After the code executes, the stack contains an int hashcode.
        +
        Parameters:
        b - CodeBuilder to which to add the code
        valueType - the type of the value
        testForNull - if true and the value is a reference and might be null
        mixIn - if true, stack has an existing hashcode followed by a value
        Since:
        +
        1.2.2
        +
      • +
      + + + +
        +
      • +

        addEqualsCall

        +
        public static void addEqualsCall(org.cojen.classfile.CodeBuilder b,
        +                 java.lang.String fieldName,
        +                 org.cojen.classfile.TypeDesc fieldType,
        +                 boolean testForNull,
        +                 org.cojen.classfile.Label fail,
        +                 org.cojen.classfile.LocalVariable other)
        +
        Generates code to compare a field in this object against the same one in a + different instance. Branch to the provided Label if they are not equal.
        +
        Parameters:
        b - CodeBuilder to which to add the code
        fieldName - the name of the field
        fieldType - the type of the field
        testForNull - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.
        fail - the label to branch to
        other - the other instance to test
        +
      • +
      + + + +
        +
      • +

        addValuesEqualCall

        +
        public static void addValuesEqualCall(org.cojen.classfile.CodeBuilder b,
        +                      org.cojen.classfile.TypeDesc valueType,
        +                      boolean testForNull,
        +                      org.cojen.classfile.Label label,
        +                      boolean choice)
        +
        Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal. Both values must be of the same + type. If they are floating point values, NaN is considered equal to NaN, + which is inconsistent with the usual treatment for NaN. + +

        The generated instruction consumes both values on the stack.

        +
        Parameters:
        b - CodeBuilder to which to add the code
        valueType - the type of the values
        testForNull - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.
        label - the label to branch to
        choice - when true, branch to label if values are equal, else + branch to label if values are unequal.
        +
      • +
      + + + +
        +
      • +

        convertValue

        +
        public static void convertValue(org.cojen.classfile.CodeBuilder b,
        +                java.lang.Class from,
        +                java.lang.Class to)
        +
        Converts a value on the stack. If "to" type is a String, then conversion + may call the String.valueOf(from).
        +
      • +
      + + + +
        +
      • +

        initialVersion

        +
        public static void initialVersion(org.cojen.classfile.CodeBuilder b,
        +                  org.cojen.classfile.TypeDesc type,
        +                  int value)
        +                           throws SupportException
        +
        Generates code to push an initial version property value on the stack.
        +
        Throws:
        +
        SupportException - if version type is not supported
        +
      • +
      + + + +
        +
      • +

        incrementVersion

        +
        public static void incrementVersion(org.cojen.classfile.CodeBuilder b,
        +                    org.cojen.classfile.TypeDesc type)
        +                             throws SupportException
        +
        Generates code to increment a version property value, already on the stack.
        +
        Throws:
        +
        SupportException - if version type is not supported
        +
      • +
      + + + +
        +
      • +

        blankValue

        +
        public static void blankValue(org.cojen.classfile.CodeBuilder b,
        +              org.cojen.classfile.TypeDesc type)
        +
        Generates code to push a blank value to the stack. For objects, it is + null, and for primitive types it is zero or false.
        +
      • +
      + + + +
        +
      • +

        bindQueryParam

        +
        public static org.cojen.classfile.TypeDesc bindQueryParam(java.lang.Class clazz)
        +
        Determines which overloaded "with" method on Query should be bound to.
        +
      • +
      + + + +
        +
      • +

        callStringBuilderAppendString

        +
        public static void callStringBuilderAppendString(org.cojen.classfile.CodeBuilder b)
        +
        Appends a String to a StringBuilder. A StringBuilder and String must be + on the stack, and a StringBuilder is left on the stack after the call.
        +
      • +
      + + + +
        +
      • +

        callStringBuilderAppendChar

        +
        public static void callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder b)
        +
        Appends a char to a StringBuilder. A StringBuilder and char must be on + the stack, and a StringBuilder is left on the stack after the call.
        +
      • +
      + + + +
        +
      • +

        callStringBuilderLength

        +
        public static void callStringBuilderLength(org.cojen.classfile.CodeBuilder b)
        +
        Calls length on a StringBuilder on the stack, leaving an int on the stack.
        +
      • +
      + + + +
        +
      • +

        callStringBuilderSetLength

        +
        public static void callStringBuilderSetLength(org.cojen.classfile.CodeBuilder b)
        +
        Calls setLength on a StringBuilder. A StringBuilder and int must be on + the stack, and both are consumed after the call.
        +
      • +
      + + + +
        +
      • +

        callStringBuilderToString

        +
        public static void callStringBuilderToString(org.cojen.classfile.CodeBuilder b)
        +
        Calls toString on a StringBuilder. A StringBuilder must be on the stack, + and a String is left on the stack after the call.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html new file mode 100644 index 0000000..7217bbf --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html @@ -0,0 +1,1091 @@ + + + + + + +CommonMethodNames (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class CommonMethodNames

+
+
+ +
+
    +
  • +
    +
    +
    public class CommonMethodNames
    +extends java.lang.Object
    +
    Collection of constant method names for the public API.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOAD_METHOD_NAME

        +
        public static final java.lang.String LOAD_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        INSERT_METHOD_NAME

        +
        public static final java.lang.String INSERT_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        UPDATE_METHOD_NAME

        +
        public static final java.lang.String UPDATE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        DELETE_METHOD_NAME

        +
        public static final java.lang.String DELETE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TRY_LOAD_METHOD_NAME

        +
        public static final java.lang.String TRY_LOAD_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TRY_INSERT_METHOD_NAME

        +
        public static final java.lang.String TRY_INSERT_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TRY_UPDATE_METHOD_NAME

        +
        public static final java.lang.String TRY_UPDATE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TRY_DELETE_METHOD_NAME

        +
        public static final java.lang.String TRY_DELETE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        STORABLE_TYPE_METHOD_NAME

        +
        public static final java.lang.String STORABLE_TYPE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_METHOD_NAME

        +
        public static final java.lang.String COPY_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        CLONE_METHOD_NAME

        +
        public static final java.lang.String CLONE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_ALL_PROPERTIES

        +
        public static final java.lang.String COPY_ALL_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_PRIMARY_KEY_PROPERTIES

        +
        public static final java.lang.String COPY_PRIMARY_KEY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_VERSION_PROPERTY

        +
        public static final java.lang.String COPY_VERSION_PROPERTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_UNEQUAL_PROPERTIES

        +
        public static final java.lang.String COPY_UNEQUAL_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COPY_DIRTY_PROPERTIES

        +
        public static final java.lang.String COPY_DIRTY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        HAS_DIRTY_PROPERTIES

        +
        public static final java.lang.String HAS_DIRTY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        MARK_PROPERTIES_CLEAN

        +
        public static final java.lang.String MARK_PROPERTIES_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        MARK_ALL_PROPERTIES_CLEAN

        +
        public static final java.lang.String MARK_ALL_PROPERTIES_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        MARK_PROPERTIES_DIRTY

        +
        public static final java.lang.String MARK_PROPERTIES_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        MARK_ALL_PROPERTIES_DIRTY

        +
        public static final java.lang.String MARK_ALL_PROPERTIES_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PROPERTY_UNINITIALIZED

        +
        public static final java.lang.String IS_PROPERTY_UNINITIALIZED
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PROPERTY_DIRTY

        +
        public static final java.lang.String IS_PROPERTY_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PROPERTY_CLEAN

        +
        public static final java.lang.String IS_PROPERTY_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PROPERTY_SUPPORTED

        +
        public static final java.lang.String IS_PROPERTY_SUPPORTED
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        GET_PROPERTY_VALUE

        +
        public static final java.lang.String GET_PROPERTY_VALUE
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        SET_PROPERTY_VALUE

        +
        public static final java.lang.String SET_PROPERTY_VALUE
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_MAP

        +
        public static final java.lang.String PROPERTY_MAP
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        WRITE_TO

        +
        public static final java.lang.String WRITE_TO
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        READ_FROM

        +
        public static final java.lang.String READ_FROM
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TO_STRING_KEY_ONLY_METHOD_NAME

        +
        public static final java.lang.String TO_STRING_KEY_ONLY_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TO_STRING_METHOD_NAME

        +
        public static final java.lang.String TO_STRING_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        HASHCODE_METHOD_NAME

        +
        public static final java.lang.String HASHCODE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        EQUALS_METHOD_NAME

        +
        public static final java.lang.String EQUALS_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        EQUAL_PRIMARY_KEYS_METHOD_NAME

        +
        public static final java.lang.String EQUAL_PRIMARY_KEYS_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        EQUAL_PROPERTIES_METHOD_NAME

        +
        public static final java.lang.String EQUAL_PROPERTIES_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        QUERY_METHOD_NAME

        +
        public static final java.lang.String QUERY_METHOD_NAME
        +
        Storage API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PREPARE_METHOD_NAME

        +
        public static final java.lang.String PREPARE_METHOD_NAME
        +
        Storage API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        LOAD_ONE_METHOD_NAME

        +
        public static final java.lang.String LOAD_ONE_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        TRY_LOAD_ONE_METHOD_NAME

        +
        public static final java.lang.String TRY_LOAD_ONE_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        AND_METHOD_NAME

        +
        public static final java.lang.String AND_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        WITH_METHOD_NAME

        +
        public static final java.lang.String WITH_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        FETCH_METHOD_NAME

        +
        public static final java.lang.String FETCH_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        STORAGE_FOR_METHOD_NAME

        +
        public static final java.lang.String STORAGE_FOR_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        ENTER_TRANSACTION_METHOD_NAME

        +
        public static final java.lang.String ENTER_TRANSACTION_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME

        +
        public static final java.lang.String GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        SET_FOR_UPDATE_METHOD_NAME

        +
        public static final java.lang.String SET_FOR_UPDATE_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        COMMIT_METHOD_NAME

        +
        public static final java.lang.String COMMIT_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        EXIT_METHOD_NAME

        +
        public static final java.lang.String EXIT_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommonMethodNames

        +
        public CommonMethodNames()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html new file mode 100644 index 0000000..30c113f --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html @@ -0,0 +1,245 @@ + + + + + + +DelegateStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class DelegateStorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class DelegateStorableGenerator<S extends Storable>
    +extends java.lang.Object
    +
    Generates and caches concrete implementations of Storable types + which delegate to DelegateSupport. The delegating classes extend + those generated by MasterStorableGenerator.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable
      java.lang.Class<? extends S>
      getDelegateClass(java.lang.Class<S> type, + java.util.EnumSet<MasterFeature> features) +
      Delegate class has a constructor that accepts a DelegateSupport + instance.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        getDelegateClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getDelegateClass(java.lang.Class<S> type,
        +                                                                 java.util.EnumSet<MasterFeature> features)
        +                                                                      throws SupportException
        +
        Delegate class has a constructor that accepts a DelegateSupport + instance. + +
        + public <init>(DelegateSupport);
        + 
        +
        Throws:
        +
        SupportException
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DelegateSupport.html b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html new file mode 100644 index 0000000..eb2b2cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html @@ -0,0 +1,298 @@ + + + + + + +DelegateSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Interface DelegateSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html new file mode 100644 index 0000000..3d2c468 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html @@ -0,0 +1,267 @@ + + + + + + +DetachedStorableFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class DetachedStorableFactory<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class DetachedStorableFactory<S extends Storable>
    +extends java.lang.Object
    +
    Creates Storable instances which are basic data containers. All load + and store operations throw an exception, as do accesses to join properties.
    +
    Since:
    +
    1.2.2
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DetachedStorableFactory(java.lang.Class<S> type) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable
      S
      newInstance() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        newInstance

        +
        public <S extends Storable> S newInstance()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/MasterFeature.html b/apidocs/com/amazon/carbonado/gen/MasterFeature.html new file mode 100644 index 0000000..1a3e680 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterFeature.html @@ -0,0 +1,501 @@ + + + + + + +MasterFeature (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Enum MasterFeature

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<MasterFeature>
    +
    +
    +
    +
    public enum MasterFeature
    +extends java.lang.Enum<MasterFeature>
    +
    Master feature to enable when using MasterStorableGenerator.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DELETE_TXN +
      Ensure delete operation always is in a transaction.
      +
      DELETE_TXN_FOR_UPDATE +
      Ensure delete operation always is in a transaction, "for update".
      +
      INSERT_CHECK_REQUIRED +
      Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.
      +
      INSERT_NO_CHECK_PRIMARY_PK +
      Insert operation never checks if primary key is filled in.
      +
      INSERT_SEQUENCES +
      Insert operation applies any sequences to unset properties.
      +
      INSERT_TXN +
      Ensure insert operation always is in a transaction.
      +
      INSERT_TXN_FOR_UPDATE +
      Ensure insert operation always is in a transaction, "for update".
      +
      NORMALIZE +
      Insert and update operations normalize property types such as BigDecimal.
      +
      PARTITIONING +
      Enforce rules for Storables which have a partition key
      +
      UPDATE_FULL +
      Update operations load clean copy first, to prevent destructive update.
      +
      UPDATE_TXN +
      Ensure update operation always is in a transaction.
      +
      UPDATE_TXN_FOR_UPDATE +
      Ensure update operation always is in a transaction, "for update".
      +
      VERSIONING +
      Insert and update operations implement record versioning, if version property exists.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static MasterFeaturevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static MasterFeature[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        VERSIONING

        +
        public static final MasterFeature VERSIONING
        +
        Insert and update operations implement record versioning, if version property exists.
        +
      • +
      + + + +
        +
      • +

        NORMALIZE

        +
        public static final MasterFeature NORMALIZE
        +
        Insert and update operations normalize property types such as BigDecimal.
        +
      • +
      + + + +
        +
      • +

        UPDATE_FULL

        +
        public static final MasterFeature UPDATE_FULL
        +
        Update operations load clean copy first, to prevent destructive update.
        +
      • +
      + + + +
        +
      • +

        UPDATE_TXN

        +
        public static final MasterFeature UPDATE_TXN
        +
        Ensure update operation always is in a transaction.
        +
      • +
      + + + +
        +
      • +

        UPDATE_TXN_FOR_UPDATE

        +
        public static final MasterFeature UPDATE_TXN_FOR_UPDATE
        +
        Ensure update operation always is in a transaction, "for update".
        +
      • +
      + + + +
        +
      • +

        INSERT_SEQUENCES

        +
        public static final MasterFeature INSERT_SEQUENCES
        +
        Insert operation applies any sequences to unset properties.
        +
      • +
      + + + +
        +
      • +

        INSERT_CHECK_REQUIRED

        +
        public static final MasterFeature INSERT_CHECK_REQUIRED
        +
        Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.
        +
      • +
      + + + +
        +
      • +

        INSERT_NO_CHECK_PRIMARY_PK

        +
        public static final MasterFeature INSERT_NO_CHECK_PRIMARY_PK
        +
        Insert operation never checks if primary key is filled in.
        +
      • +
      + + + +
        +
      • +

        INSERT_TXN

        +
        public static final MasterFeature INSERT_TXN
        +
        Ensure insert operation always is in a transaction.
        +
      • +
      + + + +
        +
      • +

        INSERT_TXN_FOR_UPDATE

        +
        public static final MasterFeature INSERT_TXN_FOR_UPDATE
        +
        Ensure insert operation always is in a transaction, "for update".
        +
      • +
      + + + +
        +
      • +

        DELETE_TXN

        +
        public static final MasterFeature DELETE_TXN
        +
        Ensure delete operation always is in a transaction.
        +
      • +
      + + + +
        +
      • +

        DELETE_TXN_FOR_UPDATE

        +
        public static final MasterFeature DELETE_TXN_FOR_UPDATE
        +
        Ensure delete operation always is in a transaction, "for update".
        +
      • +
      + + + +
        +
      • +

        PARTITIONING

        +
        public static final MasterFeature PARTITIONING
        +
        Enforce rules for Storables which have a partition key
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static MasterFeature[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (MasterFeature c : MasterFeature.values())
        +    System.out.println(c);
        +
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static MasterFeature valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + 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) + + + + + + + +
+ + + + + +
+ + + +
+
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
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/MasterSupport.html b/apidocs/com/amazon/carbonado/gen/MasterSupport.html new file mode 100644 index 0000000..26380cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterSupport.html @@ -0,0 +1,246 @@ + + + + + + +MasterSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Interface MasterSupport<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        getSequenceValueProducer

        +
        SequenceValueProducer getSequenceValueProducer(java.lang.String name)
        +                                               throws PersistException
        +
        Returns a sequence value producer by name, or throw PersistException if not found. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html new file mode 100644 index 0000000..452304b --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html @@ -0,0 +1,228 @@ + + + + + + +StorableCopier.From (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class StorableCopier.From<S extends Storable>

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

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T extends Storable
      StorableCopier<S,T>
      to(java.lang.Class<T> target) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.html new file mode 100644 index 0000000..2d49f89 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.html @@ -0,0 +1,370 @@ + + + + + + +StorableCopier (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class StorableCopier<S extends Storable,T extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class StorableCopier<S extends Storable,T extends Storable>
    +extends java.lang.Object
    +
    Copies properties between otherwise incompatible Storables. Only matched + properties are copied, and primitive types are converted.
    +
    Since:
    +
    1.2.2
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableCopier

        +
        protected StorableCopier()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

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

        copyAllProperties

        +
        public abstract void copyAllProperties(S source,
        +                     T target)
        +
      • +
      + + + + + +
        +
      • +

        copyPrimaryKeyProperties

        +
        public abstract void copyPrimaryKeyProperties(S source,
        +                            T target)
        +
      • +
      + + + + + +
        +
      • +

        copyVersionProperty

        +
        public abstract void copyVersionProperty(S source,
        +                       T target)
        +
      • +
      + + + + + +
        +
      • +

        copyUnequalProperties

        +
        public abstract void copyUnequalProperties(S source,
        +                         T target)
        +
      • +
      + + + + + +
        +
      • +

        copyDirtyProperties

        +
        public abstract void copyDirtyProperties(S source,
        +                       T target)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html new file mode 100644 index 0000000..074f949 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html @@ -0,0 +1,755 @@ + + + + + + +StorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class StorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public final class StorableGenerator<S extends Storable>
    +extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable + types. This greatly simplifies the process of defining new kinds of Repositories, since most of the mundane code generation is taken + care of.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Don Schneider, Tobias Holgers
    +
    See Also:
    MasterStorableGenerator, +DelegateStorableGenerator
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringADAPTER_FIELD_ELEMENT +
      Adapter field names are propertyName + "$adapter$" + number
      +
      static java.lang.StringCHECK_PK_FOR_DELETE_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_INSERT_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_LOAD_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_UPDATE_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCONSTRAINT_FIELD_ELEMENT +
      Constraint field names are propertyName + "$constraint$" + number
      +
      static java.lang.StringDO_TRY_DELETE_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_INSERT_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_LOAD_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_UPDATE_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringIS_ALT_KEY_INITIALIZED_PREFIX +
      Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.
      +
      static java.lang.StringIS_PARTITION_KEY_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + partition keys are uninitialized.
      +
      static java.lang.StringIS_PK_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + primary keys are uninitialized.
      +
      static java.lang.StringIS_REQUIRED_DATA_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.
      +
      static java.lang.StringIS_VERSION_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if + version property is uninitialized.
      +
      static java.lang.StringLOAD_COMPLETED_METHOD_NAME +
      Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.
      +
      static intPROPERTY_STATE_CLEAN +
      Property state indicating that property value reflects a clean value
      +
      static intPROPERTY_STATE_DIRTY +
      Property state indicating that property has been set, but not saved
      +
      static java.lang.StringPROPERTY_STATE_FIELD_NAME +
      Prefix of protected field in generated storable that holds property + states.
      +
      static intPROPERTY_STATE_MASK +
      Property state mask is 3, to cover the two bits used by a property state
      +
      static intPROPERTY_STATE_UNINITIALIZED +
      Property state indicating that property has never been set, loaded, or saved
      +
      static java.lang.StringSUPPORT_FIELD_NAME +
      Reference to TriggerSupport instance
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

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

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

        DO_TRY_INSERT_METHOD_NAME

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

        DO_TRY_UPDATE_METHOD_NAME

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

        DO_TRY_DELETE_METHOD_NAME

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

        CHECK_PK_FOR_INSERT_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_INSERT_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        CHECK_PK_FOR_UPDATE_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_UPDATE_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        CHECK_PK_FOR_DELETE_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_DELETE_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        CHECK_PK_FOR_LOAD_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_LOAD_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PK_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_PK_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + primary keys are uninitialized.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_PARTITION_KEY_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_PARTITION_KEY_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + partition keys are uninitialized.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_ALT_KEY_INITIALIZED_PREFIX

        +
        public static final java.lang.String IS_ALT_KEY_INITIALIZED_PREFIX
        +
        Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized. The complete name is + formed by the prefix appended with the zero-based alternate key number.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        IS_VERSION_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_VERSION_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if + version property is uninitialized. If no version property exists, then + this method is not defined.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        LOAD_COMPLETED_METHOD_NAME

        +
        public static final java.lang.String LOAD_COMPLETED_METHOD_NAME
        +
        Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.
        +
        Since:
        +
        1.2
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_STATE_FIELD_NAME

        +
        public static final java.lang.String PROPERTY_STATE_FIELD_NAME
        +
        Prefix of protected field in generated storable that holds property + states. Each property consumes two bits to hold its state, and so each + 32-bit field holds states for up to 16 properties.
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        ADAPTER_FIELD_ELEMENT

        +
        public static final java.lang.String ADAPTER_FIELD_ELEMENT
        +
        Adapter field names are propertyName + "$adapter$" + number
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        CONSTRAINT_FIELD_ELEMENT

        +
        public static final java.lang.String CONSTRAINT_FIELD_ELEMENT
        +
        Constraint field names are propertyName + "$constraint$" + number
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        SUPPORT_FIELD_NAME

        +
        public static final java.lang.String SUPPORT_FIELD_NAME
        +
        Reference to TriggerSupport instance
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_STATE_UNINITIALIZED

        +
        public static final int PROPERTY_STATE_UNINITIALIZED
        +
        Property state indicating that property has never been set, loaded, or saved
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_STATE_DIRTY

        +
        public static final int PROPERTY_STATE_DIRTY
        +
        Property state indicating that property has been set, but not saved
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_STATE_CLEAN

        +
        public static final int PROPERTY_STATE_CLEAN
        +
        Property state indicating that property value reflects a clean value
        +
        See Also:
        Constant Field Values
        +
      • +
      + + + +
        +
      • +

        PROPERTY_STATE_MASK

        +
        public static final int PROPERTY_STATE_MASK
        +
        Property state mask is 3, to cover the two bits used by a property state
        +
        See Also:
        Constant Field Values
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type)
        +                                                                      throws 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 signature for the returned + abstract class is defined as follows: + +
        + /**
        +  * @param support  Access to triggers
        +  */
        + public <init>(TriggerSupport support);
        + 
        + +

        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() throws PersistException;
        +
        + // Update the object in the storage.
        + protected abstract boolean doTryUpdate() throws PersistException;
        +
        + // Delete the object from the storage layer by the primary key.
        + protected abstract boolean doTryDelete() throws PersistException;
        + 
        + + A set of protected hook methods are provided which ensure that all + primary keys are initialized before performing a repository + operation. Subclasses may override them, if they are capable of filling + in unspecified primary keys. One such example is applying a sequence on + insert. + +
        + // Throws exception if any primary keys are uninitialized.
        + // Actual method name defined by CHECK_PK_FOR_INSERT_METHOD_NAME.
        + protected void checkPkForInsert() throws IllegalStateException;
        +
        + // Throws exception if any primary keys are uninitialized.
        + // Actual method name defined by CHECK_PK_FOR_UPDATE_METHOD_NAME.
        + protected void checkPkForUpdate() throws IllegalStateException;
        +
        + // Throws exception if any primary keys are uninitialized.
        + // Actual method name defined by CHECK_PK_FOR_DELETE_METHOD_NAME.
        + protected void checkPkForDelete() throws IllegalStateException;
        + 
        + + Each property value is defined as a protected field whose name and type + matches the property. Subclasses should access these fields directly + during loading and storing. For loading, it bypasses constraint + checks. For both, it provides better performance. + +

        Subclasses also have access to a set of property state bits stored + in protected int fields. Subclasses are not responsible for updating + these values. The intention is that these states may be used by + subclasses to support partial updates. They may otherwise be ignored. + +

        As a convenience, protected methods are provided to test and alter + the property state bits. Subclass constructors that fill all properties + with loaded values must call loadCompleted to ensure all properties are + identified as being valid and to fire any load triggers. + +

        + // Returns true if all primary key properties have been set.
        + protected boolean isPkInitialized();
        +
        + // Returns true if all partition key properties have been set.
        + protected boolean isPartitionKeyInitialized();
        +
        + // Returns true if all required data properties are set.
        + // A required data property is a non-nullable, non-primary key.
        + protected boolean isRequiredDataInitialized();
        +
        + // Returns true if a version property has been set.
        + // Note: This method is not generated if there is no version property.
        + protected boolean isVersionInitialized();
        +
        + // Must be called after load to identify all properties as valid
        + // and to fire any load triggers.
        + // Actual method name defined by LOAD_COMPLETED_METHOD_NAME.
        + protected void loadCompleted() throws FetchException;
        + 
        + + Property state field names are defined by the concatenation of + PROPERTY_STATE_FIELD_NAME and a zero-based decimal + number. To determine which field holds a particular property's state, + the field number is computed as the property number divided by 16. The + specific two-bit state position is the remainder of this division times 2.
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        java.lang.IllegalArgumentException - if type is null
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html new file mode 100644 index 0000000..8c78feb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html @@ -0,0 +1,461 @@ + + + + + + +StorablePropertyMap (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Class StorablePropertyMap<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Map<java.lang.String,java.lang.Object>
    +
    +
    +
    +
    public class StorablePropertyMap<S extends Storable>
    +extends java.util.AbstractMap<java.lang.String,java.lang.Object>
    +
    Basic implementation for Storable.propertyMap() method.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.util.AbstractMap

        +java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
      • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface java.util.Map

        +java.util.Map.Entry<K,V>
      • +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      booleancontainsKey(java.lang.Object key) 
      static <S extends Storable
      StorablePropertyMap<S>
      createMap(java.lang.Class<S> type, + S storable) 
      java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>entrySet() 
      java.lang.Objectget(java.lang.Object key) 
      booleanisEmpty() 
      java.util.Set<java.lang.String>keySet() 
      java.lang.Objectput(java.lang.String key, + java.lang.Object value) 
      java.lang.Objectremove(java.lang.Object key) 
      intsize() 
      java.util.Collection<java.lang.Object>values() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractMap

        +clone, containsValue, equals, hashCode, putAll, toString
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

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

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        size in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        isEmpty in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        containsKey in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        get in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        put

        +
        public java.lang.Object put(java.lang.String key,
        +                   java.lang.Object value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        put in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        remove in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        clear in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<java.lang.String> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        keySet in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<java.lang.Object> values()
        +
        +
        Specified by:
        +
        values in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        values in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Specified by:
        +
        entrySet in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/StorableSupport.html new file mode 100644 index 0000000..5ba4940 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableSupport.html @@ -0,0 +1,237 @@ + + + + + + +StorableSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Interface StorableSupport<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RepositorygetRootRepository() +
      Returns the root parent Repository that the Storable came from.
      +
      booleanisPropertySupported(java.lang.String propertyName) +
      Returns true if the given property exists and is supported.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRootRepository

        +
        Repository getRootRepository()
        +
        Returns the root parent Repository that the Storable came from.
        +
      • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.String propertyName)
        +
        Returns true if the given property exists and is supported.
        +
        Parameters:
        propertyName - name of property to check
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html new file mode 100644 index 0000000..6664e02 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html @@ -0,0 +1,326 @@ + + + + + + +TriggerSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.gen
+

Interface TriggerSupport<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        getInsertTrigger

        +
        Trigger<? super S> getInsertTrigger()
        +
        Returns a trigger which must be run for all insert operations.
        +
        Returns:
        null if no trigger
        +
      • +
      + + + +
        +
      • +

        getUpdateTrigger

        +
        Trigger<? super S> getUpdateTrigger()
        +
        Returns a trigger which must be run for all update operations.
        +
        Returns:
        null if no trigger
        +
      • +
      + + + +
        +
      • +

        getDeleteTrigger

        +
        Trigger<? super S> getDeleteTrigger()
        +
        Returns a trigger which must be run for all delete operations.
        +
        Returns:
        null if no trigger
        +
      • +
      + + + +
        +
      • +

        getLoadTrigger

        +
        Trigger<? super S> getLoadTrigger()
        +
        Returns a trigger which must be run for all load and fetch operations.
        +
        Returns:
        null if no trigger
        Since:
        +
        1.2
        +
      • +
      + + + +
        +
      • +

        locallyDisableLoadTrigger

        +
        void locallyDisableLoadTrigger()
        +
        Disables execution of load trigger for the current thread. Call + locallyEnableLoadTrigger to enable again. This call can be made multiple + times, but be sure to call locallyEnableLoadTrigger the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
      • +
      + + + +
        +
      • +

        locallyEnableLoadTrigger

        +
        void locallyEnableLoadTrigger()
        +
        Enables execution of load trigger for the current thread, if they it + been disabled before.
        +
        Since:
        +
        1.2
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html b/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html new file mode 100644 index 0000000..3a72b62 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.CodeBuilderUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.CodeBuilderUtil

+
+
No usage of com.amazon.carbonado.gen.CodeBuilderUtil
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html b/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html new file mode 100644 index 0000000..7e6acdd --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.CommonMethodNames (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.CommonMethodNames

+
+
No usage of com.amazon.carbonado.gen.CommonMethodNames
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html new file mode 100644 index 0000000..0f82f55 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.DelegateStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.DelegateStorableGenerator

+
+
No usage of com.amazon.carbonado.gen.DelegateStorableGenerator
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html new file mode 100644 index 0000000..cdf1a8f --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.DelegateSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.gen.DelegateSupport

+
+
No usage of com.amazon.carbonado.gen.DelegateSupport
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html b/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html new file mode 100644 index 0000000..f110ac0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.DetachedStorableFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.DetachedStorableFactory

+
+
No usage of com.amazon.carbonado.gen.DetachedStorableFactory
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html new file mode 100644 index 0000000..bac4cdf --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.MasterFeature (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.MasterFeature

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html new file mode 100644 index 0000000..1bb172c --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.MasterStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.MasterStorableGenerator

+
+
No usage of com.amazon.carbonado.gen.MasterStorableGenerator
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html new file mode 100644 index 0000000..cff74da --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.MasterSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.gen.MasterSupport

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html new file mode 100644 index 0000000..b5f4a8d --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorableCopier.From (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.StorableCopier.From

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html new file mode 100644 index 0000000..6c69b53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorableCopier (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.StorableCopier

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html new file mode 100644 index 0000000..62af1d6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.StorableGenerator

+
+
No usage of com.amazon.carbonado.gen.StorableGenerator
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html new file mode 100644 index 0000000..6b5be53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html @@ -0,0 +1,160 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorablePropertyMap (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.gen.StorablePropertyMap

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html new file mode 100644 index 0000000..53be458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.StorableSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.gen.StorableSupport

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html new file mode 100644 index 0000000..62d1c01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html @@ -0,0 +1,219 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.TriggerSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.gen.TriggerSupport

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-frame.html b/apidocs/com/amazon/carbonado/gen/package-frame.html new file mode 100644 index 0000000..2a3cb8a --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-frame.html @@ -0,0 +1,39 @@ + + + + + + +com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.gen

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-summary.html b/apidocs/com/amazon/carbonado/gen/package-summary.html new file mode 100644 index 0000000..5b325cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-summary.html @@ -0,0 +1,249 @@ + + + + + + +com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Package com.amazon.carbonado.gen

+
+
Storable code generation support intended for use by repository implementations.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.gen Description

+
Storable code generation support intended for use by repository implementations.
+
Since:
+
1.2
+
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-tree.html b/apidocs/com/amazon/carbonado/gen/package-tree.html new file mode 100644 index 0000000..5a392c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-tree.html @@ -0,0 +1,170 @@ + + + + + + +com.amazon.carbonado.gen Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Hierarchy For Package com.amazon.carbonado.gen

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-use.html b/apidocs/com/amazon/carbonado/gen/package-use.html new file mode 100644 index 0000000..64fe2be --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-use.html @@ -0,0 +1,250 @@ + + + + + + +Uses of Package com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Package
com.amazon.carbonado.gen

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3