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/MasterFeature.html | 501 +++++++++++++++++++++ 1 file changed, 501 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/gen/MasterFeature.html (limited to 'apidocs/com/amazon/carbonado/gen/MasterFeature.html') 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.

+ + -- cgit v1.2.3