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 --- apidocs/com/amazon/carbonado/Automatic.html | 181 ++++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/Automatic.html (limited to 'apidocs/com/amazon/carbonado/Automatic.html') diff --git a/apidocs/com/amazon/carbonado/Automatic.html b/apidocs/com/amazon/carbonado/Automatic.html new file mode 100644 index 0000000..6a57514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Automatic.html @@ -0,0 +1,181 @@ + + + + + + +Automatic (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Automatic

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Automatic
    +
    Identifies a Storable property capable of selecting its own value on + insert. The actual process by which a value is automatically assigned is + repository dependent. In the JDBC repository, the value might come from an + auto-increment column or a database-specific trigger. + +

    If the underlying repository doesn't automatically supply a value to an + automatic property, no immediate warning is given and instead the property + will be assigned a default value of null or zero. This may cause problems if + the automatic property is a member of a key. Explicitly specifying a value + can sometimes be used to bypass the automatic value altogether. + +

    Example:

    + @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Automatic
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Sequence
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3