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/PrimaryKey.html | 225 +++++++++++++++++++++++++++ 1 file changed, 225 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/PrimaryKey.html (limited to 'apidocs/com/amazon/carbonado/PrimaryKey.html') diff --git a/apidocs/com/amazon/carbonado/PrimaryKey.html b/apidocs/com/amazon/carbonado/PrimaryKey.html new file mode 100644 index 0000000..d916a4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/PrimaryKey.html @@ -0,0 +1,225 @@ + + + + + + +PrimaryKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado
+

Annotation Type PrimaryKey

+
+
+
+
    +
  • +
    +
    +
    @Documented
    +@Retention(value=RUNTIME)
    +@Target(value=TYPE)
    +public @interface PrimaryKey
    +
    Identifies a Storable property as being a member of the primary + key. All Storable types must have at least one property belonging to the + primary key. + +

    Example:

    + @PrimaryKey("userInfoID")
    + public interface UserInfo extends Storable<UserInfo> {
    +     long getUserInfoID();
    +     void setUserInfoID(long id);
    +
    +     ...
    + }
    + 
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    AlternateKeys, +Sequence
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3